Moved Config to be a simple class with a dedicated entry point instead of using the singleton pattern

Author: holgerd77

bin/cli.ts

@@ -7,6 +7,7 @@ const { fromName: serverFromName } = require('../lib/net/server')
 import Node from '../lib/node'
 import { Server as RPCServer } from 'jayson'
 import { Config } from '../lib/config'
+import Common from '@ethereumjs/common'
 const RPCManager = require('../lib/rpc')
 const level = require('level')
 const os = require('os')
@@ -82,7 +83,7 @@ const args = require('yargs')
   .locale('en_EN').argv
 const logger = getLogger({ loglevel: args.loglevel })
 
-async function runNode(options: any, config: Config) {
+async function runNode(options: any) {
   logger.info('Initializing Ethereumjs client...')
   if (options.lightserv) {
     logger.info(`Serving light peer requests`)
@@ -95,7 +96,7 @@ async function runNode(options: any, config: Config) {
   node.on('synchronized', () => {
     logger.info('Synchronized')
   })
-  logger.info(`Connecting to network: ${config.common.chainName()}`)
+  logger.info(`Connecting to network: ${options.config.common.chainName()}`)
   await node.open()
   logger.info('Synchronizing blockchain...')
   await node.start()
@@ -114,13 +115,6 @@ function runRpcServer(node: any, options: any) {
 }
 
 async function run() {
-  const config = new Config({
-    logger,
-    syncmode: args.syncmode,
-    minPeers: args.minPeers,
-    maxPeers: args.maxPeers,
-  })
-
   const syncDirName = args.syncmode === 'light' ? 'lightchaindata' : 'chaindata'
   // give network id precedence over network name
   if (args.networkId) {
@@ -131,6 +125,15 @@ async function run() {
   }
   const networkDirName = args.network === 'mainnet' ? '' : `${args.network}/`
 
+  const common = new Common({ chain: args.network, hardfork: 'chainstart' })
+  const config = new Config({
+    common,
+    logger,
+    syncmode: args.syncmode,
+    minPeers: args.minPeers,
+    maxPeers: args.maxPeers,
+  })
+
   // TODO: see todo below wrt resolving chain param parsing
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const chainParams = args.params ? await parseParams(args.params) : args.network
@@ -140,21 +143,22 @@ async function run() {
     if (t.name === 'rlpx') {
       t.options.bootnodes = t.options.bootnodes || config.common.bootstrapNodes()
     }
-    return new Server({ logger, ...t.options })
+    return new Server({ config, ...t.options })
   })
   const dataDir = `${args.datadir}/${networkDirName}ethereumjs/${syncDirName}`
 
   fs.ensureDirSync(dataDir)
   logger.info(`Data directory: ${dataDir}`)
 
   const options = {
+    config,
     servers,
     lightserv: args.lightserv,
     db: level(dataDir),
     rpcport: args.rpcport,
     rpcaddr: args.rpcaddr,
   }
-  const node = await runNode(options, config)
+  const node = await runNode(options)
   const server = args.rpc ? runRpcServer(node, options) : null
 
   process.on('SIGINT', async () => {

lib/blockchain/chain.ts

@@ -12,7 +12,7 @@ export interface ChainOptions {
   /**
    * Client configuration instance
    */
-  config?: Config
+  config: Config
 
   /**
    * Database to store blocks and metadata. Should be an abstract-leveldown compliant store.
@@ -99,10 +99,10 @@ export class Chain extends EventEmitter {
    * Create new chain
    * @param {ChainOptions} options
    */
-  constructor(options: ChainOptions = {}) {
+  constructor(options: ChainOptions) {
     super()
 
-    this.config = new Config()
+    this.config = options.config
 
     this.blockchain =
       options.blockchain ||

lib/config.ts

@@ -28,48 +28,24 @@ export interface Options {
 }
 
 export class Config {
-  public common!: Common
-  public logger!: Logger
-  public syncmode!: string
-  public minPeers!: number
-  public maxPeers!: number
-
-  static instance: Config
+  public common: Common
+  public logger: Logger
+  public syncmode: string
+  public minPeers: number
+  public maxPeers: number
 
   constructor(options: Options = {}) {
-    if (!Config.instance) {
-      Config.instance = this
-
-      // Set default values on first initialization
-
-      // Initialize Common with an explicit 'chainstart' HF set until
-      // hardfork awareness is implemented within the library
-      // Also a fix for https://github.com/ethereumjs/ethereumjs-vm/issues/757
-
-      // TODO: map chainParams (and lib/util.parseParams) to new Common format
-      Config.instance.common = new Common({ chain: 'mainnet', hardfork: 'chainstart' })
-      Config.instance.logger = defaultLogger
-      Config.instance.syncmode = 'fast'
-      Config.instance.minPeers = 3
-      Config.instance.maxPeers = 25
-    }
-
-    if (options.common) {
-      Config.instance.common = options.common
-    }
-    if (options.logger) {
-      Config.instance.logger = options.logger
-    }
-    if (options.syncmode) {
-      Config.instance.syncmode = options.syncmode
-    }
-    if (options.minPeers) {
-      Config.instance.minPeers = options.minPeers
-    }
-    if (options.maxPeers) {
-      Config.instance.maxPeers = options.maxPeers
-    }
-
-    return Config.instance
+    // Initialize Common with an explicit 'chainstart' HF set until
+    // hardfork awareness is implemented within the library
+    // Also a fix for https://github.com/ethereumjs/ethereumjs-vm/issues/757
+
+    // TODO: map chainParams (and lib/util.parseParams) to new Common format
+    this.common = options.common
+      ? options.common
+      : new Common({ chain: 'mainnet', hardfork: 'chainstart' })
+    this.logger = options.logger ? options.logger : defaultLogger
+    this.syncmode = options.syncmode ? options.syncmode : 'fast'
+    this.minPeers = options.minPeers ? options.minPeers : 3
+    this.maxPeers = options.maxPeers ? options.maxPeers : 25
   }
 }

lib/net/peer/peer.ts

@@ -41,7 +41,7 @@ export class Peer extends events.EventEmitter {
   constructor(options: any) {
     super()
 
-    this.config = new Config()
+    this.config = options.config
 
     options = { ...defaultOptions, ...options }
 

lib/net/peerpool.ts

@@ -39,7 +39,7 @@ export class PeerPool extends EventEmitter {
   constructor(options: any) {
     super()
 
-    this.config = new Config()
+    this.config = options.config
 
     options = { ...defaultOptions, ...options }
 

lib/net/protocol/boundprotocol.ts

@@ -23,6 +23,7 @@ export class BoundProtocol extends EventEmitter {
   /**
    * Create bound protocol
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Protocol} options.protocol protocol to bind
    * @param {Peer}     options.peer peer that protocol is bound to
    * @param {Sender}   options.sender message sender
@@ -31,7 +32,7 @@ export class BoundProtocol extends EventEmitter {
   constructor(options: any) {
     super()
 
-    this.config = new Config()
+    this.config = options.config
 
     this.protocol = options.protocol
     this.peer = options.peer

lib/net/protocol/ethprotocol.ts

@@ -55,6 +55,7 @@ export class EthProtocol extends Protocol {
   /**
    * Create eth protocol
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Chain}    options.chain blockchain
    * @param {number}   [options.timeout=8000] handshake timeout in ms
    */

lib/net/protocol/lesprotocol.ts

@@ -67,6 +67,7 @@ export class LesProtocol extends Protocol {
   /**
    * Create les protocol
    * @param {Object}      options constructor parameters
+   * @param {Config}      [options.config] Client configuration
    * @param {Chain}       options.chain blockchain
    * @param {FlowControl} [options.flow] flow control manager. if undefined,
    * header serving will be disabled

lib/net/protocol/protocol.ts

@@ -43,12 +43,13 @@ export class Protocol extends EventEmitter {
   /**
    * Create new protocol
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {number}   [options.timeout=8000] handshake timeout in ms
    */
   constructor(options?: any) {
     super()
 
-    this.config = new Config()
+    this.config = options.config
 
     options = { ...defaultOptions, ...options }
     this.timeout = options.timeout
@@ -170,6 +171,7 @@ export class Protocol extends EventEmitter {
    */
   async bind(peer: Peer, sender: Sender): Promise<BoundProtocol> {
     const bound = new BoundProtocol({
+      config: this.config,
       protocol: this,
       peer: peer,
       sender: sender,

lib/net/server/libp2pserver.ts

@@ -26,6 +26,7 @@ export class Libp2pServer extends Server {
   /**
    * Create new DevP2P/RLPx server
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Object[]} [options.bootnodes] list of bootnodes to use for discovery (can be
    * a comma separated string or list)
    * @param {multiaddr[]}   [options.multiaddrs] multiaddrs to listen on (can be
@@ -225,6 +226,7 @@ export class Libp2pServer extends Server {
 
   createPeer(peerInfo: any) {
     const peer = new Libp2pPeer({
+      config: this.config,
       id: peerInfo.id.toB58String(),
       multiaddrs: peerInfo.multiaddrs.toArray().map((ma: any) => ma.toString()),
       protocols: Array.from(this.protocols),