improve test/rpc/helpers code:

  * add more type information
  * rename `node` to `client` (to reflect changes in prior PR)
  * rename `blockChainStub` to `mockBlockchain`

Author: ryanio

packages/client/test/rpc/helpers.ts

@@ -1,17 +1,18 @@
 import tape from 'tape'
 import { Server as RPCServer, HttpServer } from 'jayson/promise'
-const request = require('supertest')
 import Common from '@ethereumjs/common'
 import { RPCManager as Manager } from '../../lib/rpc'
-import * as Logger from '../../lib/logging'
-import { blockChain } from './blockChainStub'
+import { getLogger } from '../../lib/logging'
+import { mockBlockchain } from './mockBlockchain'
 import { Chain } from '../../lib/blockchain/chain'
 import { RlpxServer } from '../../lib/net/server/rlpxserver'
-import Blockchain from '@ethereumjs/blockchain'
 import { Config } from '../../lib/config'
+import type Blockchain from '@ethereumjs/blockchain'
+import type EthereumClient from '../../lib/client'
+const request = require('supertest')
 
 const config: any = { loglevel: 'error' }
-config.logger = Logger.getLogger(config)
+config.logger = getLogger(config)
 
 export function startRPC(methods: any, port: number = 3000) {
   const server = new RPCServer(methods)
@@ -24,59 +25,63 @@ export function closeRPC(server: HttpServer) {
   server.close()
 }
 
-export function createManager(node: any) {
-  return new Manager(node, config)
+export function createManager(client: EthereumClient) {
+  return new Manager(client, config)
 }
 
-export function createNode(nodeConfig?: any) {
-  const common = nodeConfig?.commonChain ?? new Common({ chain: 'mainnet' })
+export function createClient(clientOpts: any = {}) {
+  const common = clientOpts.commonChain ?? new Common({ chain: 'mainnet' })
   const config = new Config({ transports: [], common })
-  const chain = new Chain({
-    config,
-    blockchain: (<unknown>blockChain({})) as Blockchain,
-  })
+  const blockchain = (<any>mockBlockchain()) as Blockchain
+
+  const chain = new Chain({ config, blockchain })
   chain.opened = true
-  const defaultNodeConfig = {
+
+  const defaultClientConfig = {
     blockchain: chain,
     opened: true,
     ethProtocolVersions: [63],
   }
-  const trueNodeConfig = { ...defaultNodeConfig, ...nodeConfig }
+  const clientConfig = { ...defaultClientConfig, ...clientOpts }
+
   const servers = [
     new RlpxServer({
       config,
       bootnodes: '10.0.0.1:1234,10.0.0.2:1234',
     }),
   ]
-  return {
+
+  const client: any = {
     services: [
       {
         name: 'eth',
-        chain: trueNodeConfig.blockchain,
+        chain: clientConfig.blockchain,
         pool: { peers: [1, 2, 3] },
         protocols: [
           {
             name: 'eth',
-            versions: trueNodeConfig.ethProtocolVersions,
+            versions: clientConfig.ethProtocolVersions,
           },
         ],
       },
     ],
     servers,
-    opened: trueNodeConfig.opened,
+    opened: clientConfig.opened,
     server: (name: string) => {
       return servers.find((s) => s.name === name)
     },
   }
+
+  return client as EthereumClient
 }
 
 export function baseSetup() {
-  const manager = createManager(createNode())
+  const manager = createManager(createClient())
   const server = startRPC(manager.getMethods())
   return server
 }
 
-export function params(method: any, params: any[] = []) {
+export function params(method: string, params: Array<any> = []) {
   const req = {
     jsonrpc: '2.0',
     method,
@@ -86,14 +91,20 @@ export function params(method: any, params: any[] = []) {
   return req
 }
 
-export function baseRequest(t: tape.Test, server: any, req: any, expect: any, expectRes: any) {
+export function baseRequest(
+  t: tape.Test,
+  server: HttpServer,
+  req: Object,
+  expect: number,
+  expectRes: Function
+) {
   request(server)
     .post('/')
     .set('Content-Type', 'application/json')
     .send(req)
     .expect(expect)
     .expect(expectRes)
-    .end((err: any) => {
+    .end((err?: Error) => {
       closeRPC(server)
       t.end(err)
     })

packages/client/test/rpc/blockChainStub.ts renamed to packages/client/test/rpc/mockBlockchain.ts

@@ -1,7 +1,7 @@
 import { Block } from '@ethereumjs/block'
 import { bufferToHex } from 'ethereumjs-util'
 
-export function blockChain(options: any) {
+export function mockBlockchain(options: any = {}) {
   const txHash = Buffer.from(
     '0be3065cf288b071ccff922c1c601e2e5628d488b66e781c260ecee36054a2dc',
     'hex'
@@ -21,10 +21,10 @@ export function blockChain(options: any) {
     }),
   }
   return {
-    getBlock: async function (_data: any) {
-      return Promise.resolve(block)
+    getBlock: async (_data: any) => {
+      return block
     },
-    getLatestHeader() {
+    getLatestHeader: () => {
       return Block.fromBlockData().header
     },
   }