remove unneeded generateCanonicalGenesis, improve comments, improve type importing

Author: ryanio

packages/client/lib/rpc/index.ts

@@ -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/modules/admin.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()

packages/client/lib/rpc/modules/eth.ts

@@ -1,3 +1,4 @@
+import { Transaction } from '@ethereumjs/tx'
 import {
   Account,
   Address,
@@ -8,13 +9,14 @@ import {
   unpadBuffer,
   setLengthLeft,
 } from 'ethereumjs-util'
-import { Transaction } from '@ethereumjs/tx'
 import { decode } from 'rlp'
-import { Chain } from '../../blockchain'
 import { middleware, validators } from '../validation'
-import { EthereumClient } from '../..'
 import { INVALID_PARAMS } from '../error-code'
 import { RpcCallTx } from '../types'
+import type { Chain } from '../../blockchain'
+import type { EthereumClient } from '../..'
+import type { EthereumService } from '../../service'
+import type { EthProtocol } from '../../net/protocol'
 import type VM from '@ethereumjs/vm'
 
 /**
@@ -31,17 +33,11 @@ export class Eth {
    * @param client Client to which the module binds
    */
   constructor(client: EthereumClient) {
-    const service = client.services.find((s) => s.name === 'eth')
-    if (!service) {
-      throw new Error('cannot find eth service')
-    }
+    const service = client.services.find((s) => s.name === 'eth') as EthereumService
     this._chain = service.chain
     this._vm = (service.synchronizer as any)?.execution?.vm
 
-    const ethProtocol = service.protocols.find((p) => p.name === 'eth')
-    if (!ethProtocol) {
-      throw new Error('cannot find eth protocol')
-    }
+    const ethProtocol = service.protocols.find((p) => p.name === 'eth') as EthProtocol
     this.ethVersion = Math.max(...ethProtocol.versions)
 
     this.blockNumber = middleware(this.blockNumber.bind(this), 0)
@@ -158,7 +154,8 @@ export class Eth {
   /**
    * Generates and returns an estimate of how much gas is necessary to allow the transaction to complete.
    * The transaction will not be added to the blockchain.
-   * Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.
+   * Note that the estimate may be significantly more than the amount of gas actually used by the transaction,
+   * for a variety of reasons including EVM mechanics and node performance.
    * Currently only "latest" block number is supported.
    * @param params An array of two parameters:
    *   1. The transaction object
@@ -244,7 +241,7 @@ export class Eth {
    * Returns information about a block by block number.
    * @param params An array of two parameters:
    *   1. integer of a block number
-   *   2. boolean determining whether it returns full transaction objects or just the transaction hashes
+   *   2. boolean - if true returns the full transaction objects, if false only the hashes of the transactions.
    */
   async getBlockByNumber(params: [string, boolean]) {
     const [blockNumber, includeTransactions] = params
@@ -261,7 +258,7 @@ export class Eth {
    * Returns information about a block by hash.
    * @param params An array of two parameters:
    *   1. a block hash
-   *   2. boolean to determine returning full transaction objects or just transaction hashes
+   *   2. boolean - if true returns the full transaction objects, if false only the hashes of the transactions.
    */
   async getBlockByHash(params: [string, boolean]) {
     const [blockHash, includeTransactions] = params
@@ -315,7 +312,7 @@ export class Eth {
   /**
    * Returns the value from a storage position at a given address.
    * Currently only "latest" block number is supported.
-   * @param  {Array<string>} [params] An array of three parameters:
+   * @param params An array of three parameters:
    *   1. address of the storage
    *   2. integer of the position in the storage
    *   3. integer block number, or the string "latest", "earliest" or "pending"
@@ -373,7 +370,7 @@ export class Eth {
 
   /**
    * Returns the current ethereum protocol version as a hex-encoded string
-   * @param  {Array<*>} [params] An empty array
+   * @param params An empty array
    */
   protocolVersion(_params = []) {
     return `0x${this.ethVersion.toString(16)}`

packages/client/lib/rpc/modules/net.ts

@@ -1,27 +1,27 @@
-import { Chain } from '../../blockchain'
-import { EthereumService } from '../../service/ethereumservice'
 import { middleware } from '../validation'
 import { addHexPrefix } from 'ethereumjs-util'
-import { EthereumClient } from '../..'
-import { PeerPool } from '../../net/peerpool'
+import type { EthereumClient } from '../..'
+import type { Chain } from '../../blockchain'
+import type { PeerPool } from '../../net/peerpool'
+import type { EthereumService } from '../../service/ethereumservice'
 
 /**
  * net_* RPC module
  * @memberof module:rpc/modules
  */
 export class Net {
   private _chain: Chain
-  private _node: EthereumClient
+  private _client: EthereumClient
   private _peerPool: PeerPool
 
   /**
    * Create net_* RPC module
-   * @param {Node} Node to which the module binds
+   * @param client Client to which the module binds
    */
-  constructor(node: EthereumClient) {
-    const service: EthereumService = node.services.find((s) => s.name === 'eth')!
+  constructor(client: EthereumClient) {
+    const service: EthereumService = client.services.find((s) => s.name === 'eth')!
     this._chain = service.chain
-    this._node = node
+    this._client = client
     this._peerPool = service.pool
 
     this.version = middleware(this.version.bind(this), 0, [])
@@ -31,23 +31,23 @@ export class Net {
 
   /**
    * Returns the current network id
-   * @param  {Array<*>} [params] An empty array
+   * @param params An empty array
    */
   version(_params = []) {
     return `${this._chain.config.chainCommon.chainId()}`
   }
 
   /**
    * Returns true if client is actively listening for network connections
-   * @param  {Array<*>} [params] An empty array
+   * @param params An empty array
    */
   listening(_params = []) {
-    return this._node.opened
+    return this._client.opened
   }
 
   /**
    * Returns number of peers currently connected to the client
-   * @param  {Array<*>} [params] An empty array
+   * @param params An empty array
    */
   peerCount(_params = []) {
     return addHexPrefix(this._peerPool.peers.length.toString(16))

packages/client/lib/rpc/modules/web3.ts

@@ -1,8 +1,9 @@
-import { middleware, validators } from '../validation'
 import { addHexPrefix, keccak, toBuffer } from 'ethereumjs-util'
+import { middleware, validators } from '../validation'
 import { getClientVersion } from '../../util'
-import { EthereumClient } from '../..'
-import { Chain } from '../../blockchain'
+import type { EthereumClient } from '../..'
+import type { Chain } from '../../blockchain'
+import type { EthereumService } from '../../service'
 
 /**
  * web3_* RPC module
@@ -13,11 +14,11 @@ export class Web3 {
 
   /**
    * Create web3_* RPC module
-   * @param {Node} Node to which the module binds
+   * @param client Client to which the module binds
    */
-  constructor(node: EthereumClient) {
-    const service = node.services.find((s) => s.name === 'eth')
-    this._chain = service?.chain
+  constructor(client: EthereumClient) {
+    const service = client.services.find((s) => s.name === 'eth') as EthereumService
+    this._chain = service.chain
 
     this.clientVersion = middleware(this.clientVersion.bind(this), 0, [])
 
@@ -26,15 +27,15 @@ export class Web3 {
 
   /**
    * Returns the current client version
-   * @param  {Array<*>} [params] An empty array
+   * @param params An empty array
    */
   clientVersion(_params = []) {
     return getClientVersion()
   }
 
   /**
    * Returns Keccak-256 (not the standardized SHA3-256) of the given data
-   * @param  {Array<string>} [params] The data to convert into a SHA3 hash
+   * @param params The data to convert into a SHA3 hash
    */
   sha3(params: string[]) {
     const rawDigest = keccak(toBuffer(params[0]))

packages/client/test/rpc/eth/call.spec.ts

@@ -17,10 +17,6 @@ tape(`${method}: call with valid arguments`, async (t) => {
   const service = client.services.find((s) => s.name === 'eth')
   const vm = (service!.synchronizer as FullSynchronizer).execution.vm
 
-  // since synchronizer.run() is not executed in the mock setup,
-  // manually run stateManager.generateCanonicalGenesis()
-  await vm.stateManager.generateCanonicalGenesis()
-
   // genesis address with balance
   const address = Address.fromString('0xccfd725760a68823ff1e062f4cc97e1360e8d997')
 

packages/client/test/rpc/eth/estimateGas.spec.ts

@@ -17,10 +17,6 @@ tape(`${method}: call with valid arguments`, async (t) => {
   const service = client.services.find((s) => s.name === 'eth')
   const vm = (service!.synchronizer as FullSynchronizer).execution.vm
 
-  // since synchronizer.run() is not executed in the mock setup,
-  // manually run stateManager.generateCanonicalGenesis()
-  await vm.stateManager.generateCanonicalGenesis()
-
   // genesis address with balance
   const address = Address.fromString('0xccfd725760a68823ff1e062f4cc97e1360e8d997')
 

packages/client/test/rpc/eth/getCode.spec.ts

@@ -40,10 +40,6 @@ tape(`${method}: ensure returns correct code`, async (t) => {
   const service = client.services.find((s) => s.name === 'eth')
   const vm = (service!.synchronizer as FullSynchronizer).execution.vm
 
-  // since synchronizer.run() is not executed in the mock setup,
-  // manually run stateManager.generateCanonicalGenesis()
-  await vm.stateManager.generateCanonicalGenesis()
-
   // genesis address with balance
   const address = Address.fromString('0xccfd725760a68823ff1e062f4cc97e1360e8d997')
 

packages/client/test/rpc/eth/getStorageAt.spec.ts

@@ -17,10 +17,6 @@ const setup = async () => {
   const service = client.services.find((s) => s.name === 'eth')
   const vm = (service!.synchronizer as FullSynchronizer).execution.vm
 
-  // since synchronizer.run() is not executed in the mock setup,
-  // manually run stateManager.generateCanonicalGenesis()
-  await vm.stateManager.generateCanonicalGenesis()
-
   // genesis address with balance
   const address = Address.fromString('0xccfd725760a68823ff1e062f4cc97e1360e8d997')
 

packages/client/test/rpc/eth/getTransactionCount.spec.ts

@@ -13,7 +13,7 @@ tape(`${method}: call with valid arguments`, async (t) => {
   const manager = createManager(createClient({ blockchain, includeVM: true }))
   const server = startRPC(manager.getMethods())
 
-  // random genesis address
+  // a genesis address
   const address = Address.fromString('0xccfd725760a68823ff1e062f4cc97e1360e8d997')
 
   // verify nonce is 0
@@ -39,7 +39,7 @@ tape(`${method}: ensure count increments after a tx`, async (t) => {
   const service = client.services.find((s) => s.name === 'eth')
   const vm = (service!.synchronizer as FullSynchronizer).execution.vm
 
-  // random genesis address with existing balance
+  // a genesis address
   const address = Address.fromString('0xccfd725760a68823ff1e062f4cc97e1360e8d997')
 
   // construct tx