client: split cli transports option for bootnodes and multiaddrs

Author: ryanio

packages/client/README.md

@@ -213,7 +213,7 @@ listener. The second client will use libp2p to connect to the first client.
 Run the first client and start downloading blocks:
 
 ```
-ethereumjs --syncmode full --lightserv true  --datadir first --network rinkeby --transports rlpx libp2p:multiaddrs=/ip4/127.0.0.1/tcp/50505/ws
+ethereumjs --syncmode full --lightserv true  --datadir first --network rinkeby --transports rlpx libp2p --multiaddrs /ip4/127.0.0.1/tcp/50505/ws
 ```
 
 Output:
@@ -230,10 +230,10 @@ Copy the libp2p URL from the output. In this example, the url is `/ip4/127.0.0.1
 Wait until a few thousand blocks are downloaded and then run the second client in a new terminal, using the url above to connect to the first client:
 
 <pre>
-ethereumjs --syncmode light --network rinkeby --datadir second --transports libp2p:multiaddrs=/ip4/0.0.0.0/tcp/50506,bootnodes=<b>/ip4/127.0.0.1/tcp/50505/ws/p2p/QmYAuYxw6QX1x5aafs6g3bUrPbMDifP5pDun3N9zbVLpEa</b>
+ethereumjs --syncmode light --network rinkeby --datadir second --transports libp2p --multiaddrs /ip4/0.0.0.0/tcp/50506 --bootnodes=<b>/ip4/127.0.0.1/tcp/50505/ws/p2p/QmYAuYxw6QX1x5aafs6g3bUrPbMDifP5pDun3N9zbVLpEa</b>
 </pre>
 
-Notice that we have to run the second client on port 50506 using the `multiaddrs=/ip4/0.0.0.0/tcp/50506` libp2p option to avoid port conflicts.
+Notice that we have to run the second client on port 50506 using the `--multiaddrs /ip4/0.0.0.0/tcp/50506` libp2p option to avoid port conflicts.
 
 ### Example 2: Light sync from within a browser
 

packages/client/bin/cli.ts

@@ -2,7 +2,7 @@
 
 import { Server as RPCServer } from 'jayson/promise'
 import Common from '@ethereumjs/common'
-import { parseParams } from '../lib/util'
+import { parseParams, parseMultiaddrs } from '../lib/util'
 import EthereumClient from '../lib/client'
 import { Config } from '../lib/config'
 import { Logger } from '../lib/logging'
@@ -46,6 +46,14 @@ const args = require('yargs')
       default: Config.TRANSPORTS_DEFAULT,
       array: true,
     },
+    bootnodes: {
+      describe: 'Network bootnodes',
+      array: true,
+    },
+    multiaddrs: {
+      describe: 'Network multiaddrs',
+      array: true,
+    },
     rpc: {
       describe: 'Enable the JSON-RPC server',
       boolean: true,
@@ -173,6 +181,8 @@ async function run() {
     lightserv: args.lightserv,
     datadir: args.datadir,
     transports: args.transports,
+    bootnodes: args.bootnodes ? parseMultiaddrs(args.bootnodes) : undefined,
+    multiaddrs: args.multiaddrs ? parseMultiaddrs(args.multiaddrs) : undefined,
     rpc: args.rpc,
     rpcport: args.rpcport,
     rpcaddr: args.rpcaddr,
@@ -203,4 +213,5 @@ async function run() {
   })
 }
 
-run().catch((err) => logger!.error(err))
+// eslint-disable-next-line no-console
+run().catch((err) => logger?.error(err) ?? console.error(err))

packages/client/lib/config.ts

@@ -1,8 +1,9 @@
 import Common from '@ethereumjs/common'
 import VM from '@ethereumjs/vm'
+import Multiaddr from 'multiaddr'
 import { getLogger, Logger } from './logging'
 import { Libp2pServer, RlpxServer } from './net/server'
-import { parseMultiaddrs, parseTransports } from './util'
+import { parseTransports } from './util'
 
 export interface ConfigOptions {
   /**
@@ -46,6 +47,18 @@ export interface ConfigOptions {
    */
   transports?: string[]
 
+  /**
+   * Network bootnodes
+   * (e.g. [email protected] or /ip4/127.0.0.1/tcp/50505/p2p/QmABC)
+   */
+  bootnodes?: Multiaddr[]
+
+  /**
+   * Network multiaddrs for libp2p
+   * (e.g. /ip4/127.0.0.1/tcp/50505/p2p/QmABC)
+   */
+  multiaddrs?: Multiaddr[]
+
   /**
    * Transport servers (RLPx or Libp2p)
    * Use `transports` option, only used for testing purposes
@@ -160,6 +173,8 @@ export class Config {
   public readonly lightserv: boolean
   public readonly datadir: string
   public readonly transports: string[]
+  public readonly bootnodes?: Multiaddr[]
+  public readonly multiaddrs?: Multiaddr[]
   public readonly rpc: boolean
   public readonly rpcport: number
   public readonly rpcaddr: string
@@ -181,6 +196,8 @@ export class Config {
     this.vm = options.vm
     this.lightserv = options.lightserv ?? Config.LIGHTSERV_DEFAULT
     this.transports = options.transports ?? Config.TRANSPORTS_DEFAULT
+    this.bootnodes = options.bootnodes
+    this.multiaddrs = options.multiaddrs
     this.datadir = options.datadir ?? Config.DATADIR_DEFAULT
     this.rpc = options.rpc ?? Config.RPC_DEFAULT
     this.rpcport = options.rpcport ?? Config.RPCPORT_DEFAULT
@@ -217,25 +234,20 @@ export class Config {
           'Config initialization with both servers and transports options not allowed'
         )
       }
-
       // Servers option takes precedence
       this.servers = options.servers
     } else {
       // Otherwise parse transports from transports option
       this.servers = parseTransports(this.transports).map((t) => {
-        // format multiaddrs as multiaddr[]
-        if (t.options.multiaddrs) {
-          t.options.multiaddrs = parseMultiaddrs(t.options.multiaddrs) as any
-        }
         if (t.name === 'rlpx') {
-          if (!t.options.bootnodes) {
-            t.options.bootnodes = this.chainCommon.bootstrapNodes()
-          }
-          t.options.bootnodes = parseMultiaddrs(t.options.bootnodes) as any
-          t.options.dnsNetworks = options.dnsNetworks ?? this.chainCommon.dnsNetworks()
-          return new RlpxServer({ config: this, ...t.options })
+          const bootnodes = this.bootnodes ?? this.chainCommon.bootstrapNodes()
+          const dnsNetworks = options.dnsNetworks ?? this.chainCommon.dnsNetworks()
+          return new RlpxServer({ config: this, bootnodes, dnsNetworks })
         } else {
-          return new Libp2pServer({ config: this, ...t.options })
+          // t.name === 'libp2p'
+          const multiaddrs = this.multiaddrs
+          const bootnodes = this.bootnodes
+          return new Libp2pServer({ config: this, multiaddrs, bootnodes })
         }
       })
     }

packages/client/lib/util/parse.ts

@@ -5,6 +5,9 @@ import { SecureTrie as Trie } from 'merkle-patricia-tree'
 import { Account, BN, keccak, rlp, toBuffer, unpadBuffer, isHexPrefixed } from 'ethereumjs-util'
 import { MultiaddrLike } from '../types'
 
+/**
+ * Parses multiaddrs and bootnodes to multiaddr format.
+ */
 export function parseMultiaddrs(input: MultiaddrLike): multiaddr[] {
   if (!input) {
     return []