Merge pull request #1130 from ethereumjs/add-new-rpc-methods

Client: Add 6 new RPC methods

Author: holgerd77

package-lock.json

@@ -307,7 +307,7 @@ to help contributors better understand how the project is organized.
 **Components**
 
 - `Chain` [**In Progress**] This class represents the blockchain and is a wrapper around
-  `ethereumjs-blockchain`. It handles creation of the data directory, provides basic blockchain operations
+  `@ethereumjs/blockchain`. It handles creation of the data directory, provides basic blockchain operations
   and maintains an updated current state of the blockchain, including current height, total difficulty, and
   latest block.
 - `Server` This class represents a server that discovers new peers and handles incoming and dropped
@@ -328,11 +328,11 @@ to help contributors better understand how the project is organized.
 - `Handler` Subclasses of this class implements a protocol message handler. Handlers respond to incoming requests from peers.
   - `EthHandler` [**In Progress**] Handles incoming ETH requests
   - `LesHandler` [**In Progress**] Handles incoming LES requests
-- `Service` Subclasses of `Service` will implement specific functionality of a `Node`. For example, the `EthereumService` subclasses will synchronize the blockchain using the full or light sync protocols. Each service must specify which protocols it needs and define a `start()` and `stop()` function.
+- `Service` Subclasses of `Service` will implement specific functionality of a `Client`. For example, the `EthereumService` subclasses will synchronize the blockchain using the full or light sync protocols. Each service must specify which protocols it needs and define a `start()` and `stop()` function.
   - `FullEthereumService` [**In Progress**] Implementation of ethereum full sync.
   - `LightEthereumService` [**In Progress**] Implementation of ethereum light sync.
   - `WhisperService` [**Not Started**] Implementation of an ethereum whisper node.
-- `Node` [**In Progress**] Represents the top-level ethereum node, and is responsible for managing the lifecycle of included services.
+- `Client` [**In Progress**] Represents the top-level ethereum client, and is responsible for managing the lifecycle of included services.
 - `RPCManager` [**In Progress**] Implements an embedded JSON-RPC server to handle incoming RPC requests.
 
 ## Developer

packages/client/README.md

@@ -9,8 +9,8 @@ import * as modules from './modules'
 /**
  * get all methods. e.g., getBlockByNumber in eth module
  * @private
- * @param  {Object}   mod
- * @return {string[]}
+ * @param Object mod
+ * @returns string[]
  */
 function getMethodNames(mod: any): string[] {
   return Object.getOwnPropertyNames(mod.prototype)

packages/client/lib/rpc/index.ts

@@ -1,11 +1,11 @@
 import { bufferToHex } from 'ethereumjs-util'
-import { Chain } from '../../blockchain'
-import { EthProtocol } from '../../net/protocol'
-import { RlpxServer } from '../../net/server'
-import EthereumClient from '../../client'
-import { EthereumService } from '../../service'
 import { getClientVersion } from '../../util'
 import { middleware } from '../validation'
+import type { Chain } from '../../blockchain'
+import type { EthProtocol } from '../../net/protocol'
+import type { RlpxServer } from '../../net/server'
+import type EthereumClient from '../../client'
+import type { EthereumService } from '../../service'
 
 /**
  * admin_* RPC module
@@ -18,7 +18,7 @@ export class Admin {
 
   /**
    * Create admin_* RPC module
-   * @param {client} EthereumClient to which the module binds
+   * @param client Client to which the module binds
    */
   constructor(client: EthereumClient) {
     const service = client.services.find((s) => s.name === 'eth') as EthereumService
@@ -32,7 +32,7 @@ export class Admin {
   /**
    * Returns information about the currently running node.
    * see for reference: https://geth.ethereum.org/docs/rpc/ns-admin#admin_nodeinfo
-   * @param {*} [params] An empty array
+   * @param params An empty array
    */
   async nodeInfo(_params: []) {
     const rlpxInfo = (this._client.server('rlpx') as RlpxServer).getRlpxInfo()