feat: add getRlpxInfo

Author: PhilippLgh

lib/net/server/rlpxserver.ts

@@ -42,6 +42,7 @@ export class RlpxServer extends Server {
 
   public rlpx: Devp2pRLPx | null = null
   public dpt: Devp2pDPT | null = null
+  public ip: string = '::'
 
   /**
    * Create new DevP2P/RLPx server
@@ -59,6 +60,8 @@ export class RlpxServer extends Server {
     super(options)
     options = { ...defaultOptions, ...options }
 
+    // TODO: get the external ip from the upnp service
+    this.ip = '::'
     this.port = options.port
     this.key = options.key
     this.clientFilter = options.clientFilter
@@ -83,6 +86,30 @@ export class RlpxServer extends Server {
     }
   }
 
+  /**
+   * Return Rlpx info
+   */
+  getRlpxInfo() {
+    // TODO: return undefined? note that this.rlpx might be undefined if called before initRlpx
+    if (!this.rlpx) {
+      return {
+        enode: undefined,
+        id: undefined,
+        ip: this.ip,
+        listenAddr: `[${this.ip}]:${this.port}`,
+        ports: { 'discovery': this.port, 'listener': this.port }
+      }
+    }
+    const id = this.rlpx._id.toString('hex')
+    return {
+      enode: `enode://${id}@[${this.ip}]:${this.port}`,
+      id: id,
+      ip: this.ip,
+      listenAddr: `[${this.ip}]:${this.port}`,
+      ports: { 'discovery': this.port, 'listener': this.port }
+    }
+  }
+
   /**
    * Start Devp2p/RLPx server. Returns a promise that resolves once server has been started.
    * @return Resolves with true if server successfully started
@@ -120,8 +147,8 @@ export class RlpxServer extends Server {
    */
   async stop(): Promise<boolean> {
     if (this.started) {
-      ;(this.rlpx as Devp2pRLPx).destroy() // eslint-disable-line no-extra-semi
-      ;(this.dpt as Devp2pDPT).destroy()
+      ; (this.rlpx as Devp2pRLPx).destroy() // eslint-disable-line no-extra-semi
+        ; (this.dpt as Devp2pDPT).destroy()
       await super.stop()
       this.started = false
     }
@@ -138,7 +165,7 @@ export class RlpxServer extends Server {
     if (!this.started) {
       return false
     }
-    ;(this.dpt as Devp2pDPT).banPeer(peerId, maxAge) // eslint-disable-line no-extra-semi
+    ; (this.dpt as Devp2pDPT).banPeer(peerId, maxAge) // eslint-disable-line no-extra-semi
     return true
   }
 
@@ -239,7 +266,7 @@ export class RlpxServer extends Server {
     this.rlpx.on('listening', () => {
       this.emit('listening', {
         transport: this.name,
-        url: `enode://${(this.rlpx as Devp2pRLPx)._id.toString('hex')}@[::]:${this.port}`,
+        url: this.getRlpxInfo().enode,
       })
     })
 

test/net/server/rlpxserver.ts

@@ -6,13 +6,13 @@ const { defaultLogger } = require('../../../lib/logging')
 defaultLogger.silent = true
 
 tape('[RlpxServer]', (t) => {
-  class RlpxPeer extends EventEmitter {}
+  class RlpxPeer extends EventEmitter { }
   RlpxPeer.capabilities = td.func()
   RlpxPeer.prototype.accept = td.func()
   td.replace('../../../lib/net/peer/rlpxpeer', RlpxPeer)
-  class RLPx extends EventEmitter {}
+  class RLPx extends EventEmitter { }
   RLPx.prototype.listen = td.func()
-  class DPT extends EventEmitter {}
+  class DPT extends EventEmitter { }
   DPT.prototype.bind = td.func()
   td.replace('ethereumjs-devp2p', { DPT, RLPx })
   td.when(
@@ -72,7 +72,35 @@ tape('[RlpxServer]', (t) => {
     t.end()
   })
 
-  t.test('should handle errors', (t) => {
+  t.test('should return rlpx server info', async (t) => {
+    const mockId = '123'
+    const server = new RlpxServer({
+      bootnodes: '10.0.0.1:1234,10.0.0.2:1234'
+    })
+    server.initDpt = td.func()
+    server.initRlpx = td.func()
+    server.dpt = td.object()
+    server.rlpx = td.object({
+      _id: mockId,
+      destroy: td.func()
+    })
+    td.when(server.dpt.bootstrap({ address: '10.0.0.1', udpPort: '1234', tcpPort: '1234' })).thenResolve()
+    td.when(server.dpt.bootstrap({ address: '10.0.0.2', udpPort: '1234', tcpPort: '1234' })).thenReject('err0')
+    server.on('error', err => t.equals(err, 'err0', 'got error'))
+    await server.start()
+    const nodeInfo = server.getRlpxInfo()
+    t.deepEqual(nodeInfo, {
+      enode: `enode://${mockId}@[::]:30303`,
+      id: mockId,
+      ip: '::',
+      listenAddr: '[::]:30303',
+      ports: { discovery: 30303, listener: 30303 }
+    }, 'get nodeInfo')
+    await server.stop()
+    t.end()
+  })
+
+  t.test('should handle errors', t => {
     t.plan(3)
     let count = 0
     const server = new RlpxServer()