client: fetch: fix Peer type in Job

client: remove any types from Sync
client: mark Sync.ts as abstract class

Author: jochem-brouwer

packages/client/lib/sync/fetcher/types.ts

@@ -1,10 +1,10 @@
-import { Peer } from "@ethereumjs/devp2p"
+import { Peer } from '../../net/peer'
 
 export type Job<JobTask, JobResult, StorageItem> = {
-    task: JobTask
-    time: number
-    index: number
-    result?: JobResult | StorageItem[]
-    state: 'idle' | 'expired' | 'active'
-    peer: Peer | null
-  }
+  task: JobTask
+  time: number
+  index: number
+  result?: JobResult | StorageItem[]
+  state: 'idle' | 'expired' | 'active'
+  peer: Peer | null
+}

packages/client/lib/sync/fullsync.ts

@@ -4,6 +4,7 @@ import { Peer } from '../net/peer/peer'
 import { short } from '../util'
 import { Synchronizer, SynchronizerOptions } from './sync'
 import { BlockFetcher } from './fetcher'
+import { Block } from '@ethereumjs/block'
 
 /**
  * Implements an ethereum full sync synchronizer
@@ -58,7 +59,7 @@ export class FullSynchronizer extends Synchronizer {
       if (peer.eth?.status) {
         const td = peer.eth.status.td
         if (
-          (!best && td.gte((this.chain.blocks as any).td)) ||
+          (!best && td.gte(this.chain.blocks.td)) ||
           (best && best.eth && best.eth.status.td.lt(td))
         ) {
           best = peer
@@ -110,7 +111,7 @@ export class FullSynchronizer extends Synchronizer {
       .on('error', (error: Error) => {
         this.emit('error', error)
       })
-      .on('fetched', (blocks: any[]) => {
+      .on('fetched', (blocks: Block[]) => {
         const first = new BN(blocks[0].header.number)
         const hash = short(blocks[0].hash())
         this.config.logger.info(
@@ -155,9 +156,9 @@ export class FullSynchronizer extends Synchronizer {
   async open(): Promise<void> {
     await this.chain.open()
     await this.pool.open()
-    const number = ((this.chain.blocks as any).height as number).toString(10)
-    const td = ((this.chain.blocks as any).td as number).toString(10)
-    const hash = ((this.chain.blocks as any).latest as any).hash()
+    const number = this.chain.blocks.height.toString(10)
+    const td = this.chain.blocks.td.toString(10)
+    const hash = this.chain.blocks.latest!.hash()
     this.config.logger.info(`Latest local block: number=${number} td=${td} hash=${short(hash)}`)
   }
 

packages/client/lib/sync/lightsync.ts

@@ -3,6 +3,7 @@ import { Synchronizer, SynchronizerOptions } from './sync'
 import { HeaderFetcher } from './fetcher/headerfetcher'
 import { BN } from 'ethereumjs-util'
 import { short } from '../util'
+import { BlockHeader } from '@ethereumjs/block'
 
 /**
  * Implements an ethereum light sync synchronizer
@@ -44,7 +45,7 @@ export class LightSynchronizer extends Synchronizer {
       if (peer.les) {
         const td = peer.les.status.headTd
         if (
-          (!best && td.gte((this.chain.headers as any).td)) ||
+          (!best && td.gte(this.chain.headers.td)) ||
           (best && best.les && best.les.status.headTd.lt(td))
         ) {
           best = peer
@@ -62,7 +63,7 @@ export class LightSynchronizer extends Synchronizer {
   async syncWithPeer(peer?: Peer): Promise<boolean> {
     if (!peer) return false
     const height = new BN(peer.les!.status.headNum)
-    const first = ((this.chain.headers as any).height as BN).addn(1)
+    const first = this.chain.headers.height.addn(1)
     const count = height.sub(first).addn(1)
     if (count.lten(0)) return false
 
@@ -83,7 +84,7 @@ export class LightSynchronizer extends Synchronizer {
       .on('error', (error: Error) => {
         this.emit('error', error)
       })
-      .on('fetched', (headers: any[]) => {
+      .on('fetched', (headers: BlockHeader[]) => {
         const first = new BN(headers[0].number)
         const hash = short(headers[0].hash())
         this.config.logger.info(
@@ -114,9 +115,9 @@ export class LightSynchronizer extends Synchronizer {
   async open(): Promise<void> {
     await this.chain.open()
     await this.pool.open()
-    const number = ((this.chain.headers as any).height as number).toString(10)
-    const td = ((this.chain.headers as any).td as number).toString(10)
-    const hash = ((this.chain.blocks as any).latest as any).hash()
+    const number = this.chain.headers.height.toString(10)
+    const td = this.chain.headers.td.toString(10)
+    const hash = this.chain.blocks.latest!.hash()
     this.config.logger.info(`Latest local header: number=${number} td=${td} hash=${short(hash)}`)
   }
 

packages/client/lib/sync/sync.ts

@@ -26,7 +26,7 @@ export interface SynchronizerOptions {
  * Base class for blockchain synchronizers
  * @memberof module:sync
  */
-export class Synchronizer extends EventEmitter {
+export abstract class Synchronizer extends EventEmitter {
   public config: Config
 
   protected pool: PeerPool
@@ -59,6 +59,8 @@ export class Synchronizer extends EventEmitter {
     })
   }
 
+  abstract async sync(): Promise<boolean>
+
   /**
    * Returns synchronizer type
    */
@@ -77,7 +79,7 @@ export class Synchronizer extends EventEmitter {
    * @return {boolean}
    */
   // TODO: evaluate syncability of peer
-  syncable(_peer: any): boolean {
+  syncable(_peer: Peer): boolean {
     return true
   }
 
@@ -94,7 +96,7 @@ export class Synchronizer extends EventEmitter {
     }, this.interval * 30)
     while (this.running) {
       try {
-        if (await (this as any).sync()) this.emit('synchronized')
+        if (await this.sync()) this.emit('synchronized')
       } catch (error) {
         this.emit('error', error)
       }

packages/client/lib/types.ts

@@ -1,5 +1,3 @@
-import { Peer } from './net/peer'
-
 export type Key = Buffer
 export type KeyLike = string | Key
 
@@ -33,4 +31,4 @@ export interface QHeap<T> {
   peek(): T | undefined
   length: number
   gc(opts: { minLength: number; maxLength: number }): void
-}
+}