client: added RLPx port as a CLI option (local option was inactive before -> always defaulted to 30303)

Author: holgerd77

packages/client/bin/cli.ts

@@ -50,6 +50,10 @@ const args = require('yargs')
       describe: 'Network bootnodes',
       array: true,
     },
+    port: {
+      describe: 'RLPx listening port',
+      default: Config.PORT_DEFAULT,
+    },
     multiaddrs: {
       describe: 'Network multiaddrs',
       array: true,
@@ -182,6 +186,7 @@ async function run() {
     datadir: args.datadir,
     transports: args.transports,
     bootnodes: args.bootnodes ? parseMultiaddrs(args.bootnodes) : undefined,
+    port: args.port,
     multiaddrs: args.multiaddrs ? parseMultiaddrs(args.multiaddrs) : undefined,
     rpc: args.rpc,
     rpcport: args.rpcport,

packages/client/lib/config.ts

@@ -43,7 +43,7 @@ export interface ConfigOptions {
   /**
    * Network transports ('rlpx' and/or 'libp2p')
    *
-   * Default: `['rlpx:port=30303', 'libp2p']`
+   * Default: `['rlpx', 'libp2p']`
    */
   transports?: string[]
 
@@ -53,6 +53,13 @@ export interface ConfigOptions {
    */
   bootnodes?: Multiaddr[]
 
+  /**
+   * RLPx listening port
+   *
+   * Default: `30303`
+   */
+  port?: number
+
   /**
    * Network multiaddrs for libp2p
    * (e.g. /ip4/127.0.0.1/tcp/50505/p2p/QmABC)
@@ -157,7 +164,8 @@ export class Config {
   public static readonly SYNCMODE_DEFAULT = 'full'
   public static readonly LIGHTSERV_DEFAULT = false
   public static readonly DATADIR_DEFAULT = `./datadir`
-  public static readonly TRANSPORTS_DEFAULT = ['rlpx:port=30303', 'libp2p']
+  public static readonly TRANSPORTS_DEFAULT = ['rlpx', 'libp2p']
+  public static readonly PORT_DEFAULT = 30303
   public static readonly RPC_DEFAULT = false
   public static readonly RPCPORT_DEFAULT = 8545
   public static readonly RPCADDR_DEFAULT = 'localhost'
@@ -174,6 +182,7 @@ export class Config {
   public readonly datadir: string
   public readonly transports: string[]
   public readonly bootnodes?: Multiaddr[]
+  public readonly port?: number
   public readonly multiaddrs?: Multiaddr[]
   public readonly rpc: boolean
   public readonly rpcport: number
@@ -197,6 +206,7 @@ export class Config {
     this.lightserv = options.lightserv ?? Config.LIGHTSERV_DEFAULT
     this.transports = options.transports ?? Config.TRANSPORTS_DEFAULT
     this.bootnodes = options.bootnodes
+    this.port = options.port ?? Config.PORT_DEFAULT
     this.multiaddrs = options.multiaddrs
     this.datadir = options.datadir ?? Config.DATADIR_DEFAULT
     this.rpc = options.rpc ?? Config.RPC_DEFAULT

packages/client/lib/net/server/rlpxserver.ts

@@ -4,9 +4,6 @@ import { RlpxPeer } from '../peer/rlpxpeer'
 import { Server, ServerOptions } from './server'
 
 export interface RlpxServerOptions extends ServerOptions {
-  /* Local port to listen on (default: 30303) */
-  port?: number
-
   /* List of supported clients */
   clientFilter?: string[]
 }
@@ -50,7 +47,6 @@ const ignoredErrors = new RegExp(
 export class RlpxServer extends Server {
   private peers: Map<string, RlpxPeer> = new Map()
 
-  public port: number
   public discovery: boolean
   private clientFilter: string[]
 
@@ -67,7 +63,6 @@ export class RlpxServer extends Server {
 
     // TODO: get the external ip from the upnp service
     this.ip = '::'
-    this.port = options.port ?? 30303
     this.discovery = options.config.discV4 || options.config.discDns
     this.clientFilter = options.clientFilter ?? [
       'go1.5',
@@ -100,17 +95,17 @@ export class RlpxServer extends Server {
         enode: undefined,
         id: undefined,
         ip: this.ip,
-        listenAddr: `[${this.ip}]:${this.port}`,
-        ports: { discovery: this.port, listener: this.port },
+        listenAddr: `[${this.ip}]:${this.config.port}`,
+        ports: { discovery: this.config.port, listener: this.config.port },
       }
     }
     const id = this.rlpx._id.toString('hex')
     return {
-      enode: `enode://${id}@[${this.ip}]:${this.port}`,
+      enode: `enode://${id}@[${this.ip}]:${this.config.port}`,
       id: id,
       ip: this.ip,
-      listenAddr: `[${this.ip}]:${this.port}`,
-      ports: { discovery: this.port, listener: this.port },
+      listenAddr: `[${this.ip}]:${this.config.port}`,
+      ports: { discovery: this.config.port, listener: this.config.port },
     }
   }
 
@@ -233,8 +228,8 @@ export class RlpxServer extends Server {
 
     this.dpt.on('error', (e: Error) => this.error(e))
 
-    if (this.port) {
-      this.dpt.bind(this.port, '0.0.0.0')
+    if (this.config.port) {
+      this.dpt.bind(this.config.port, '0.0.0.0')
     }
   }
 
@@ -248,7 +243,7 @@ export class RlpxServer extends Server {
       maxPeers: this.config.maxPeers,
       capabilities: RlpxPeer.capabilities(Array.from(this.protocols)),
       remoteClientIdFilter: this.clientFilter,
-      listenPort: this.port,
+      listenPort: this.config.port,
       common: this.config.chainCommon,
     })
 
@@ -304,8 +299,8 @@ export class RlpxServer extends Server {
       })
     })
 
-    if (this.port) {
-      this.rlpx.listen(this.port, '0.0.0.0')
+    if (this.config.port) {
+      this.rlpx.listen(this.config.port, '0.0.0.0')
     }
   }
 }

packages/client/test/net/server/rlpxserver.spec.ts

@@ -179,7 +179,7 @@ tape('[RlpxServer]', async (t) => {
     const config = new Config({ loglevel: 'error', transports: [] })
     const server = new RlpxServer({ config })
     server.initDpt()
-    td.verify((server.dpt as any).bind(server.port, '0.0.0.0'))
+    td.verify((server.dpt as any).bind(server.config.port, '0.0.0.0'))
     server.on('error', (err: any) => t.equals(err, 'err0', 'got error'))
     ;(server.dpt as any).emit('error', 'err0')
   })
@@ -193,7 +193,7 @@ tape('[RlpxServer]', async (t) => {
     td.when(RlpxPeer.prototype.accept(rlpxPeer, td.matchers.isA(RlpxServer))).thenResolve()
     server.initRlpx()
     td.verify(RlpxPeer.capabilities(Array.from((server as any).protocols)))
-    td.verify(server.rlpx!.listen(server.port, '0.0.0.0'))
+    td.verify(server.rlpx!.listen(server.config.port, '0.0.0.0'))
     server.on('connected', (peer: any) => t.ok(peer instanceof RlpxPeer, 'connected'))
     server.on('disconnected', (peer: any) => t.equals(peer.id, '01', 'disconnected'))
     server.on('error', (err: Error) => t.equals(err.message, 'err0', 'got error'))