Merge pull request #161 from ethereumjs/integrate-singleton-config-class

New Config Class

Author: holgerd77

bin/cli.ts

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
-const Common = require('@ethereumjs/common').default
 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 Node from '../lib/node'
 import { Server as RPCServer } from 'jayson'
+import { Config } from '../lib/config'
 const RPCManager = require('../lib/rpc')
 const level = require('level')
 const os = require('os')
@@ -95,7 +95,7 @@ async function runNode(options: any) {
   node.on('synchronized', () => {
     logger.info('Synchronized')
   })
-  logger.info(`Connecting to network: ${options.common.chainName()}`)
+  logger.info(`Connecting to network: ${options.config.common.chainName()}`)
   await node.open()
   logger.info('Synchronizing blockchain...')
   await node.start()
@@ -128,16 +128,11 @@ async function run() {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const chainParams = args.params ? await parseParams(args.params) : args.network
 
-  // 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
-  const common = new Common({ chain: args.network, hardfork: 'chainstart' })
+  const config = new Config()
   const servers = parseTransports(args.transports).map((t: any) => {
     const Server = serverFromName(t.name)
     if (t.name === 'rlpx') {
-      t.options.bootnodes = t.options.bootnodes || common.bootstrapNodes()
+      t.options.bootnodes = t.options.bootnodes || config.common.bootstrapNodes()
     }
     return new Server({ logger, ...t.options })
   })
@@ -147,7 +142,7 @@ async function run() {
   logger.info(`Data directory: ${dataDir}`)
 
   const options = {
-    common,
+    config,
     logger,
     servers,
     syncmode: args.syncmode,

lib/config.ts

@@ -0,0 +1,31 @@
+import Common from '@ethereumjs/common'
+
+export interface Options {
+  /**
+   * Specify the chain and hardfork by passing a Common instance.
+   *
+   * If not provided this defaults to chain `mainnet` and hardfork `chainstart`
+   */
+  common?: Common
+}
+
+export class Config {
+  public common!: Common
+
+  static instance: Config
+
+  constructor(options: Options = {}) {
+    if (Config.instance) {
+      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 || new Common({ chain: 'mainnet', hardfork: 'chainstart' })
+
+    Config.instance = this
+  }
+}

lib/node.ts

@@ -1,6 +1,7 @@
 import * as events from 'events'
 import { FastEthereumService, LightEthereumService } from './service'
 import { defaultLogger } from './logging'
+import { Config } from './config'
 
 const defaultOptions = {
   minPeers: 3,
@@ -15,8 +16,9 @@ const defaultOptions = {
  * @memberof module:node
  */
 export default class Node extends events.EventEmitter {
+  public config: Config
+
   public logger: any
-  public common: any
   public servers: any
   public syncmode: any
   public services: any
@@ -27,8 +29,8 @@ export default class Node extends events.EventEmitter {
   /**
    * Create new node
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Logger}   [options.logger] Logger instance
-   * @param {Common}   [options.common] common parameters
    * @param {LevelDB}  [options.db=null] blockchain database
    * @param {string}   [options.syncmode=light] synchronization mode ('fast' or 'light')
    * @param {boolean}  [options.lightserv=false] serve LES requests
@@ -42,9 +44,8 @@ export default class Node extends events.EventEmitter {
   constructor(options: any) {
     super()
     options = { ...defaultOptions, ...options }
-
+    this.config = options.config || new Config()
     this.logger = options.logger
-    this.common = options.common
     this.servers = options.servers
     this.syncmode = options.syncmode
     this.services = [
@@ -53,15 +54,15 @@ export default class Node extends events.EventEmitter {
             servers: this.servers,
             logger: this.logger,
             lightserv: options.lightserv,
-            common: options.common,
+            config: this.config,
             minPeers: options.minPeers,
             maxPeers: options.maxPeers,
             db: options.db,
           })
         : new LightEthereumService({
             servers: this.servers,
             logger: this.logger,
-            common: options.common,
+            config: this.config,
             minPeers: options.minPeers,
             maxPeers: options.maxPeers,
             db: options.db,

lib/service/ethereumservice.ts

@@ -1,11 +1,10 @@
 import { Service } from './service'
 import { FlowControl } from '../net/protocol/flowcontrol'
 import { Chain } from '../blockchain'
-import Common from '@ethereumjs/common'
+import { Config } from '../config'
 
 const defaultOptions = {
   lightserv: false,
-  common: new Common({ chain: 'mainnet', hardfork: 'chainstart' }),
   minPeers: 3,
   timeout: 8000,
   interval: 1000,
@@ -16,9 +15,10 @@ const defaultOptions = {
  * @memberof module:service
  */
 export class EthereumService extends Service {
+  public config: Config
+
   public flow: FlowControl
   public chain: Chain
-  public common: Common
   public minPeers: number
   public interval: number
   public timeout: number
@@ -27,10 +27,10 @@ export class EthereumService extends Service {
   /**
    * Create new ETH service
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Server[]} options.servers servers to run service on
    * @param {Chain}    [options.chain] blockchain
    * @param {LevelDB}  [options.db=null] blockchain database
-   * @param {Common}   [options.common] ethereum network name
    * @param {number}   [options.minPeers=3] number of peers needed before syncing
    * @param {number}   [options.maxPeers=25] maximum peers allowed
    * @param {number}   [options.timeout] protocol timeout
@@ -41,9 +41,10 @@ export class EthereumService extends Service {
     options = { ...defaultOptions, ...options }
     super(options)
 
+    this.config = options.config || new Config()
+
     this.flow = new FlowControl(options)
     this.chain = options.chain || new Chain(options)
-    this.common = options.common
     this.minPeers = options.minPeers
     this.interval = options.interval
     this.timeout = options.timeout

lib/service/fastethereumservice.ts

@@ -18,10 +18,10 @@ export class FastEthereumService extends EthereumService {
   /**
    * Create new ETH service
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Server[]} options.servers servers to run service on
    * @param {boolean}  [options.lightserv=false] serve LES requests
    * @param {Chain}    [options.chain] blockchain
-   * @param {Common}   [options.common] ethereum network name
    * @param {number}   [options.minPeers=3] number of peers needed before syncing
    * @param {number}   [options.maxPeers=25] maximum peers allowed
    * @param {number}   [options.interval] sync retry interval
@@ -40,7 +40,7 @@ export class FastEthereumService extends EthereumService {
       logger: this.logger,
       pool: this.pool,
       chain: this.chain,
-      common: this.common,
+      common: this.config.common,
       minPeers: this.minPeers,
       interval: this.interval,
     })

lib/service/lightethereumservice.ts

@@ -11,9 +11,9 @@ export class LightEthereumService extends EthereumService {
   /**
    * Create new ETH service
    * @param {Object}   options constructor parameters
+   * @param {Config}   [options.config] Client configuration
    * @param {Server[]} options.servers servers to run service on
    * @param {Chain}    [options.chain] blockchain
-   * @param {Common}   [options.common] ethereum network name
    * @param {number}   [options.minPeers=3] number of peers needed before syncing
    * @param {number}   [options.maxPeers=25] maximum peers allowed
    * @param {number}   [options.interval] sync retry interval
@@ -30,7 +30,7 @@ export class LightEthereumService extends EthereumService {
       logger: this.logger,
       pool: this.pool,
       chain: this.chain,
-      common: this.common,
+      common: this.config.common,
       minPeers: this.minPeers,
       flow: this.flow,
       interval: this.interval,

package.json

@@ -93,6 +93,7 @@
     "@types/node": "^14.11.5",
     "@types/tape": "^4.13.0",
     "@types/tape-catch": "^1.0.0",
+    "eslint": "^6.8.0",
     "file-replace-loader": "^1.2.0",
     "husky": "^2.1.0",
     "json-to-markdown": "^1.0.4",