Added Config -> transports as the main entry point for transport configuration, made Config.servers private, new getTransportServers() method, adopted test setup

Author: holgerd77

bin/cli.ts

@@ -1,9 +1,8 @@
 #!/usr/bin/env node
 
 const chains = require('@ethereumjs/common/dist/chains').chains
-const { getLogger } = require('../lib/logging')
-const { parseParams, parseTransports } = require('../lib/util')
-const { fromName: serverFromName } = require('../lib/net/server')
+import { getLogger } from '../lib/logging'
+import { parseParams } from '../lib/util'
 import Node from '../lib/node'
 import { Server as RPCServer } from 'jayson'
 import { Config } from '../lib/config'
@@ -42,7 +41,7 @@ const args = require('yargs')
     },
     transports: {
       describe: 'Network transports',
-      default: ['rlpx:port=30303', 'libp2p'],
+      default: Config.TRANSPORTS_DEFAULT,
       array: true,
     },
     rpc: {
@@ -128,6 +127,7 @@ async function run() {
     logger,
     syncmode: args.syncmode,
     lightserv: args.lightserv,
+    transports: args.transports,
     minPeers: args.minPeers,
     maxPeers: args.maxPeers,
   })
@@ -136,16 +136,6 @@ async function run() {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const chainParams = args.params ? await parseParams(args.params) : args.network
 
-  const servers = parseTransports(args.transports).map((t: any) => {
-    const Server = serverFromName(t.name)
-    if (t.name === 'rlpx') {
-      t.options.bootnodes = t.options.bootnodes || config.common.bootstrapNodes()
-    }
-    return new Server({ config, ...t.options })
-  })
-
-  config.servers = servers
-
   const syncDataDir = config.getSyncDataDirectory()
   fs.ensureDirSync(syncDataDir)
   logger.info(`Sync data directory: ${syncDataDir}`)

lib/config.ts

@@ -3,12 +3,13 @@ import Common from '@ethereumjs/common'
 import { Logger } from 'winston'
 import { defaultLogger } from './logging'
 import { Libp2pServer, RlpxServer } from './net/server'
+import { parseTransports } from './util'
 
 export interface Options {
   /**
    * Specify the chain and hardfork by passing a Common instance.
    *
-   * Default: chain `mainnet` and hardfork `chainstart`
+   * Default: chain 'mainnet' and hardfork 'chainstart'
    */
   common?: Common
   /**
@@ -17,12 +18,6 @@ export interface Options {
    * Default: Logger with loglevel 'debug'
    */
   logger?: Logger
-  /**
-   * Transport servers (RLPx or Libp2p)
-   *
-   * Default: []
-   */
-  servers?: (RlpxServer | Libp2pServer)[]
   /**
    * Synchronization mode ('fast' or 'light')
    *
@@ -32,45 +27,60 @@ export interface Options {
   /**
    * Serve light peer requests
    *
-   * Default: false
+   * Default: `false`
    */
   lightserv?: boolean
   /**
    * Root data directory for the blockchain
    */
   datadir?: string
+  /**
+   * Network transports ('rlpx' and/or 'libp2p')
+   *
+   * Default: `['rlpx:port=30303', 'libp2p']`
+   */
+  transports?: string[]
+  /**
+   * Transport servers (RLPx or Libp2p)
+   * Use `transports` option, only used for testing purposes
+   *
+   * Default: servers created from `transports` option
+   */
+  servers?: (RlpxServer | Libp2pServer)[]
   /**
    * Number of peers needed before syncing
    *
-   * Default: 2
+   * Default: `2`
    */
   minPeers?: number
   /**
    * Maximum peers allowed
    *
-   * Default: 25
+   * Default: `25`
    */
   maxPeers?: number
 }
 
 export class Config {
+  public static readonly COMMON_DEFAULT = new Common({ chain: 'mainnet', hardfork: 'chainstart' })
+  public static readonly LOGGER_DEFAULT = defaultLogger
+  public static readonly SYNCMODE_DEFAULT = 'fast'
+  public static readonly LIGHTSERV_DEFAULT = false
+  public static readonly DATADIR_DEFAULT = `${os.homedir()}/Library/Ethereum`
+  public static readonly TRANSPORTS_DEFAULT = ['rlpx:port=30303', 'libp2p']
+  public static readonly MINPEERS_DEFAULT = 2
+  public static readonly MAXPEERS_DEFAULT = 25
+
   public common: Common
   public logger: Logger
-  public servers: (RlpxServer | Libp2pServer)[]
   public syncmode: string
   public lightserv: boolean
   public datadir: string
+  public transports: string[]
   public minPeers: number
   public maxPeers: number
 
-  public static readonly COMMON_DEFAULT = new Common({ chain: 'mainnet', hardfork: 'chainstart' })
-  public static readonly LOGGER_DEFAULT = defaultLogger
-  public static readonly SERVERS_DEFAULT = []
-  public static readonly SYNCMODE_DEFAULT = 'fast'
-  public static readonly LIGHTSERV_DEFAULT = false
-  public static readonly DATADIR_DEFAULT = `${os.homedir()}/Library/Ethereum`
-  public static readonly MINPEERS_DEFAULT = 2
-  public static readonly MAXPEERS_DEFAULT = 25
+  private servers: (RlpxServer | Libp2pServer)[] = []
 
   constructor(options: Options = {}) {
     // Initialize Common with an explicit 'chainstart' HF set until
@@ -80,12 +90,14 @@ export class Config {
     // TODO: map chainParams (and lib/util.parseParams) to new Common format
     this.common = options.common ?? Config.COMMON_DEFAULT
     this.logger = options.logger ?? Config.LOGGER_DEFAULT
-    this.servers = options.servers ?? Config.SERVERS_DEFAULT
     this.syncmode = options.syncmode ?? Config.SYNCMODE_DEFAULT
     this.lightserv = options.lightserv ?? Config.LIGHTSERV_DEFAULT
+    this.transports = options.transports ?? Config.TRANSPORTS_DEFAULT
     this.datadir = options.datadir ?? Config.DATADIR_DEFAULT
     this.minPeers = options.minPeers ?? Config.MINPEERS_DEFAULT
     this.maxPeers = options.maxPeers ?? Config.MAXPEERS_DEFAULT
+
+    this.servers = options.servers ? options.servers : this.getTransportServers()
   }
 
   /**
@@ -100,4 +112,21 @@ export class Config {
     const dataDir = `${this.datadir}/${networkDirName}ethereumjs/${syncDirName}`
     return dataDir
   }
+
+  /**
+   * Returns the transport servers created from the `transports` option
+   */
+  getTransportServers(): (RlpxServer | Libp2pServer)[] {
+    if (this.servers.length === 0) {
+      this.servers = parseTransports(this.transports).map((t) => {
+        if (t.name === 'rlpx') {
+          t.options.bootnodes = t.options.bootnodes || this.common.bootstrapNodes()
+          return new RlpxServer({ config: this, ...t.options })
+        } else {
+          return new Libp2pServer({ config: this, ...t.options })
+        }
+      })
+    }
+    return this.servers
+  }
 }

lib/net/peerpool.ts

@@ -55,11 +55,11 @@ export class PeerPool extends EventEmitter {
     if (this.opened) {
       return false
     }
-    this.config.servers.map((server) => {
-      server.on('connected', (peer: Peer) => {
+    this.config.getTransportServers().map((s) => {
+      s.on('connected', (peer: Peer) => {
         this.connected(peer)
       })
-      server.on('disconnected', (peer: Peer) => {
+      s.on('disconnected', (peer: Peer) => {
         this.disconnected(peer)
       })
     })
@@ -196,7 +196,7 @@ export class PeerPool extends EventEmitter {
     if (this.size === 0) {
       this.noPeerPeriods += 1
       if (this.noPeerPeriods >= 3) {
-        const promises = this.config.servers.map(async (server: any) => {
+        const promises = this.config.getTransportServers().map(async (server: any) => {
           if (server.bootstrap) {
             this.config.logger.info('Retriggering bootstrap.')
             await server.bootstrap()

lib/net/server/index.ts

@@ -2,18 +2,6 @@ export { Server } from './server'
 export { RlpxServer } from './rlpxserver'
 export { Libp2pServer } from './libp2pserver'
 
-import { RlpxServer } from './rlpxserver'
-import { Libp2pServer } from './libp2pserver'
-
 /**
  * @module net/server
  */
-
-const servers: any = {
-  rlpx: RlpxServer,
-  libp2p: Libp2pServer,
-}
-
-export const fromName = function (name: string) {
-  return servers[name]
-}

lib/service/service.ts

@@ -69,7 +69,7 @@ export class Service extends events.EventEmitter {
       return false
     }
     const protocols = this.protocols
-    this.config.servers.map((s) => s.addProtocols(protocols))
+    this.config.getTransportServers().map((s) => s.addProtocols(protocols))
     if (this.pool) {
       this.pool.on('banned', (peer: Peer) => this.config.logger.debug(`Peer banned: ${peer}`))
       this.pool.on('error', (error: Error) => this.emit('error', error))
@@ -100,7 +100,7 @@ export class Service extends events.EventEmitter {
     if (this.running) {
       return false
     }
-    await Promise.all(this.config.servers.map((s) => s.start()))
+    await Promise.all(this.config.getTransportServers().map((s) => s.start()))
     this.running = true
     this.config.logger.info(`Started ${this.name} service.`)
   }

lib/util/parse.ts

@@ -21,7 +21,7 @@ export function parseBootnodes(string: string) {
   }
 }
 
-export function parseTransports(transports: any[]) {
+export function parseTransports(transports: string[]) {
   return transports.map((t) => {
     const options: any = {}
     const [name, ...pairs] = t.split(':')

test/integration/fastethereumservice.ts

@@ -12,7 +12,7 @@ tape('[Integration:FastEthereumService]', async (t) => {
     const server = new MockServer()
     const chain = new MockChain()
     const service = new FastEthereumService({
-      //@ts-ignore
+      //@ts-ignore allow Config instantiation with MockServer
       config: new Config({ servers: [server], lightserv: true }),
       chain,
     })

test/integration/fastsync.ts

@@ -14,9 +14,10 @@ tape('[Integration:FastSync]', async (t) => {
   async function setup(options: any = {}): Promise<any[]> {
     const server = new MockServer({ location: options.location })
     const chain = new MockChain({ height: options.height })
+    //@ts-ignore allow Config instantiation with MockServer
+    const config = new Config({ servers: [server], minPeers: 1 })
     const service = new FastEthereumService({
-      //@ts-ignore allow Config instantiation with MockServer
-      config: new Config({ servers: [server], minPeers: 1 }),
+      config,
       interval: options.interval || 10,
       timeout: 500,
       chain,

test/integration/lightethereumservice.ts

@@ -10,11 +10,9 @@ tape('[Integration:LightEthereumService]', async (t) => {
   async function setup() {
     const server = new MockServer()
     const chain = new MockChain()
-    const service = new LightEthereumService({
-      //@ts-ignore allow Config instantiation with MockServer
-      config: new Config({ servers: [server] }),
-      chain,
-    })
+    //@ts-ignore allow Config instantiation with MockServer
+    const config = new Config({ servers: [server] })
+    const service = new LightEthereumService({ config, chain })
     await service.open()
     await server.start()
     await service.start()

test/integration/mocks/mockchain.ts

@@ -11,7 +11,7 @@ export default class MockChain extends Chain {
   public height: any
 
   constructor(options: any = {}) {
-    super({ config: new Config(), ...options })
+    super({ config: new Config({ transports: [] }), ...options })
     options = { ...defaultOptions, ...options }
     this.height = options.height
   }