wip: quic

Author: richard-ramos

beacon_chain/conf.nim

@@ -36,7 +36,7 @@ from consensus_object_pools/block_pools_types_light_client
 
 export
   uri, nat, enr,
-  defaultEth2TcpPort, enabledLogLevel,
+  defaultEth2TcpPort, defaultEth2QuicPort, enabledLogLevel,
   defs, parseCmdArg, completeCmdArg, network_metadata,
   el_conf, network,
   confTomlDefs, confTomlNet, confTomlUri, jsnet,
@@ -299,6 +299,12 @@ type
         defaultValueDesc: $defaultEth2TcpPortDesc
         name: "tcp-port" .}: Port
 
+      quicPort* {.
+        desc: "Listening UDP port for Ethereum LibP2P traffic over QUIC"
+        defaultValue: defaultEth2QuicPort
+        defaultValueDesc: $defaultEth2QuicPortDesc
+        name: "quic-port" .}: Port
+
       udpPort* {.
         desc: "Listening UDP port for node discovery"
         defaultValue: defaultEth2TcpPort

beacon_chain/conf_light_client.nim

@@ -69,6 +69,12 @@ type LightClientConf* = object
     defaultValueDesc: $defaultEth2TcpPortDesc
     name: "tcp-port" .}: Port
 
+  quicPort* {.
+    desc: "Listening UDP port for Ethereum LibP2P traffic over QUIC"
+    defaultValue: defaultEth2QuicPort
+    defaultValueDesc: $defaultEth2QuicPortDesc
+    name: "quic-port" .}: Port
+
   udpPort* {.
     desc: "Listening UDP port for node discovery"
     defaultValue: defaultEth2TcpPort

beacon_chain/networking/eth2_discovery.nim

@@ -78,7 +78,7 @@ proc loadBootstrapFile*(bootstrapFile: string,
 
 proc new*(T: type Eth2DiscoveryProtocol,
           config: BeaconNodeConf | LightClientConf,
-          enrIp: Opt[IpAddress], enrTcpPort, enrUdpPort: Opt[Port],
+          enrIp: Opt[IpAddress], enrTcpPort, enrQuicPort, enrUdpPort: Opt[Port],
           pk: PrivateKey,
           enrFields: openArray[(string, seq[byte])], rng: ref HmacDrbgContext):
           T =
@@ -102,6 +102,7 @@ proc new*(T: type Eth2DiscoveryProtocol,
     else:
       Opt.none(IpAddress)
 
+  # TODO: what to do with enrQuicPort?
   newProtocol(pk, enrIp, enrTcpPort, enrUdpPort, enrFields, bootstrapEnrs,
     bindPort = config.udpPort, bindIp = listenAddress,
     enrAutoUpdate = config.enrAutoUpdate, rng = rng)

beacon_chain/networking/eth2_network.nim

@@ -1836,7 +1836,7 @@ proc new(T: type Eth2Node,
          enrForkId: ENRForkID, discoveryForkId: ENRForkID,
          forkDigests: ref ForkDigests, getBeaconTime: GetBeaconTimeFn,
          switch: Switch, pubsub: GossipSub,
-         ip: Opt[IpAddress], tcpPort, udpPort: Opt[Port],
+         ip: Opt[IpAddress], tcpPort, quicPort, udpPort: Opt[Port],
          privKey: keys.PrivateKey, discovery: bool,
          directPeers: DirectPeers, announcedAddresses: openArray[MultiAddress],
          rng: ref HmacDrbgContext): T =
@@ -1871,7 +1871,7 @@ proc new(T: type Eth2Node,
     forkDigests: forkDigests,
     getBeaconTime: getBeaconTime,
     discovery: Eth2DiscoveryProtocol.new(
-      config, ip, tcpPort, udpPort, privKey,
+      config, ip, tcpPort, quicPort, udpPort, privKey,
       {
         enrForkIdField: SSZ.encode(enrForkId),
         enrAttestationSubnetsField: SSZ.encode(metadata.attnets)
@@ -2231,6 +2231,9 @@ func asEthKey*(key: PrivateKey): keys.PrivateKey =
 template tcpEndPoint(address, port): auto =
   MultiAddress.init(address, tcpProtocol, port)
 
+template quicEndPoint(address, port): auto =
+  MultiAddress.init(address, udpProtocol, port) & MultiAddress.init("/quic-v1")
+
 func initNetKeys(privKey: PrivateKey): NetKeyPair =
   let pubKey = privKey.getPublicKey().expect("working public key from random")
   NetKeyPair(seckey: privKey, pubkey: pubKey)
@@ -2327,7 +2330,7 @@ func gossipId(
 proc newBeaconSwitch(
     config: BeaconNodeConf | LightClientConf,
     seckey: PrivateKey,
-    address: MultiAddress,
+    addresses: seq[MultiAddress],
     rng: ref HmacDrbgContext,
 ): Result[Switch, string] =
   let service: Service = WildcardAddressResolverService.new()
@@ -2337,12 +2340,13 @@ proc newBeaconSwitch(
   try:
     ok sb
     .withPrivateKey(seckey)
-    .withAddress(address)
+    .withAddresses(addresses)
     .withRng(rng)
     .withNoise()
-    .withMplex(chronos.minutes(5), chronos.minutes(5))
+    .withQuicTransport()
     .withMaxConnections(config.maxPeers)
     .withAgentVersion(config.agentString)
+    .withMplex(chronos.minutes(5), chronos.minutes(5))
     .withTcpTransport({ServerFlags.ReuseAddr})
     .withServices(@[service])
     .build()
@@ -2369,9 +2373,11 @@ proc createEth2Node*(
       else:
         getAutoAddress(Port(0)).toIpAddress()
 
+    # TODO: setupAddress only receives a single tcpPort and udpPort, 
+    # We need a way to pass the quic port
     (extIp, extTcpPort, extUdpPort) =
       setupAddress(config.nat, listenAddress, config.tcpPort,
-                   config.udpPort, clientId)
+                   config.quicPort, config.udpPort, clientId)
 
     directPeers = block:
       var res: DirectPeers
@@ -2396,10 +2402,16 @@ proc createEth2Node*(
         info "Adding privileged direct peer", peerId, address
       res
 
-    hostAddress = tcpEndPoint(listenAddress, config.tcpPort)
-    announcedAddresses =
-      if extIp.isNone() or extTcpPort.isNone(): @[]
-      else: @[tcpEndPoint(extIp.get(), extTcpPort.get())]
+    hostAddress = @[
+      quicEndpoint(listenAddress, config.quicUdpPort),
+      tcpEndPoint(listenAddress, config.tcpPort)
+    ]
+
+  var announcedAddresses = newSeq[Multiaddr]()
+  if not(extIp.isNone() or extTcpPort.isNone()):
+    announcedAddresses.add  tcpEndPoint(extIp.get(), extTcpPort.get())
+  if not(extIp.isNone() or extQuicUdpPort.isNone()):
+    announcedAddresses.add  quicEndpoint(extIp.get(), extQuicUdpPort.get())
 
   debug "Initializing networking", hostAddress,
                                    network_public_key = netKeys.pubkey,

beacon_chain/spec/network.nim

@@ -43,6 +43,9 @@ const
   defaultEth2TcpPort* = 9000
   defaultEth2TcpPortDesc* = $defaultEth2TcpPort
 
+  defaultEth2QuicPort* = 9001
+  defaultEth2QuicPortDesc* = $defaultEth2QuicPort
+
   # This is not part of the spec! But it's port which Lighthouse uses
   defaultEth2RestPort* = 5052
   defaultEth2RestPortDesc* = $defaultEth2RestPort