Merge pull request #184 from ethereumjs/rename-fast-to-full

Rename fast sync to full sync

Author: jochem-brouwer

README.md

@@ -177,7 +177,7 @@ Output:
 
 ### Example 1: Light sync
 
-In this example, we will run two ethereumjs-clients. The first will be a fast sync client that
+In this example, we will run two ethereumjs-clients. The first will be a full sync client that
 will connect to the rinkeby network and start downloading the blockchain. The second will be a
 light client that connects to the first client and syncs headers as they are downloaded.
 
@@ -187,7 +187,7 @@ listener. The second client will use libp2p to connect to the first client.
 Run the first client and start downloading blocks:
 
 ```
-ethereumjs --syncmode fast --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:
@@ -272,7 +272,7 @@ to help contributors better understand how the project is organized.
 - `/docs` Contains auto-generated API docs.
 - `/lib/blockchain` Contains the `Chain` class.
 - `/lib/net` Contains all of the network layer classes including `Peer`, `Protocol` and its subclasses, `Server` and its subclasses, and `PeerPool`.
-- `/lib/service` Contains the main Ethereum services (`FastEthereumService` and `LightEthereumService`).
+- `/lib/service` Contains the main Ethereum services (`FullEthereumService` and `LightEthereumService`).
 - `/lib/rpc` Contains the RPC server (optionally) embedded in the client.
 - `/lib/sync` Contains the various chain synchronizers and `Fetcher` helpers.
 - `/test` Contains test cases, testing helper functions, mocks and test data.
@@ -297,12 +297,12 @@ to help contributors better understand how the project is organized.
   and `removed` events when new peers are added and removed and also emit the `message` event whenever
   any of the peers in the pool emit a message. Each `Service` has an associated `PeerPool` and they are used primarily by `Synchronizer`s to help with blockchain synchronization.
 - `Synchronizer` Subclasses of this class implements a specific blockchain synchronization strategy. They
-  also make use of subclasses of the `Fetcher` class that help fetch headers and bodies from pool peers. The fetchers internally make use of streams to handle things like queuing and backpressure. - `FastSynchronizer` [**In Progress**] Implements fast syncing of the blockchain - `LightSynchronizer` [**In Progress**] Implements light syncing of the blockchain
+  also make use of subclasses of the `Fetcher` class that help fetch headers and bodies from pool peers. The fetchers internally make use of streams to handle things like queuing and backpressure. - `FullSynchronizer` [**In Progress**] Implements full syncing of the blockchain - `LightSynchronizer` [**In Progress**] Implements light syncing of the blockchain
 - `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 fast or light sync protocols. Each service must specify which protocols it needs and define a `start()` and `stop()` function.
-  - `FastEthereumService` [**In Progress**] Implementation of ethereum fast sync.
+- `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.
+  - `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.

bin/cli.ts

@@ -28,7 +28,7 @@ const args = require('yargs')
     },
     syncmode: {
       describe: 'Blockchain sync mode',
-      choices: ['light', 'fast'],
+      choices: ['light', 'full'],
       default: Config.SYNCMODE_DEFAULT,
     },
     lightserv: {

browser/index.ts

@@ -27,12 +27,12 @@ export * from '../lib/node'
 
 // Service
 export * from '../lib/service/service'
-export * from '../lib/service/fastethereumservice'
+export * from '../lib/service/fullethereumservice'
 export * from '../lib/service/lightethereumservice'
 
 // Synchronizer
 export * from '../lib/sync/sync'
-export * from '../lib/sync/fastsync'
+export * from '../lib/sync/fullsync'
 export * from '../lib/sync/lightsync'
 
 // Utilities
@@ -47,7 +47,7 @@ export function createNode(args: any) {
   const options = {
     common: new Common({ chain: args.network ?? 'mainnet' }),
     servers: [new exports.Libp2pServer({ multiaddrs: [], ...args })],
-    syncmode: args.syncmode ?? 'fast',
+    syncmode: args.syncmode ?? 'full',
     db: level(args.db ?? 'ethereumjs'),
     logger: logger,
   }

lib/blockchain/chain.ts

@@ -324,6 +324,6 @@ export class Chain extends EventEmitter {
    */
   async getTd(hash: Buffer, num: BN): Promise<BN> {
     await this.open()
-    return (this.blockchain as any)._getTd(hash, num)
+    return this.blockchain.getTotalDifficulty(hash, num)
   }
 }

lib/config.ts

@@ -13,9 +13,9 @@ export interface ConfigOptions {
   common?: Common
 
   /**
-   * Synchronization mode ('fast' or 'light')
+   * Synchronization mode ('full' or 'light')
    *
-   * Default: 'fast'
+   * Default: 'full'
    */
   syncmode?: string
 
@@ -101,7 +101,7 @@ export class Config {
   // hardfork awareness is implemented within the library
   // Also a fix for https://github.com/ethereumjs/ethereumjs-vm/issues/757
   public static readonly COMMON_DEFAULT = new Common({ chain: 'mainnet', hardfork: 'chainstart' })
-  public static readonly SYNCMODE_DEFAULT = 'fast'
+  public static readonly SYNCMODE_DEFAULT = 'full'
   public static readonly LIGHTSERV_DEFAULT = false
   public static readonly DATADIR_DEFAULT = `${os.homedir()}/Library/Ethereum`
   public static readonly TRANSPORTS_DEFAULT = ['rlpx:port=30303', 'libp2p']

lib/index.ts

@@ -63,7 +63,7 @@ exports.define('EthereumService', './service/ethereumservice')
 // Synchronizer
 exports.define('sync', './sync')
 exports.define('Synchronizer', './sync/sync')
-exports.define('FastSynchronizer', './sync/fastsync')
+exports.define('FullSynchronizer', './sync/fullsync')
 exports.define('LightSynchronizer', './sync/lightsync')
 
 // Utilities

lib/node.ts

@@ -2,7 +2,7 @@ import events from 'events'
 import { LevelUp } from 'levelup'
 import { BootnodeLike } from './types'
 import { Config } from './config'
-import { FastEthereumService, LightEthereumService } from './service'
+import { FullEthereumService, LightEthereumService } from './service'
 
 export interface NodeOptions {
   /* Client configuration */
@@ -29,7 +29,7 @@ export interface NodeOptions {
 export default class Node extends events.EventEmitter {
   public config: Config
 
-  public services: (FastEthereumService | LightEthereumService)[]
+  public services: (FullEthereumService | LightEthereumService)[]
 
   public opened: boolean
   public started: boolean
@@ -44,8 +44,8 @@ export default class Node extends events.EventEmitter {
     this.config = options.config
 
     this.services = [
-      this.config.syncmode === 'fast'
-        ? new FastEthereumService({
+      this.config.syncmode === 'full'
+        ? new FullEthereumService({
             config: this.config,
             db: options.db,
           })

lib/service/fastethereumservice.ts lib/service/fullethereumservice.tslib/service/fastethereumservice.ts renamed to lib/service/fullethereumservice.ts

@@ -1,11 +1,11 @@
 import { EthereumService, EthereumServiceOptions } from './ethereumservice'
-import { FastSynchronizer } from '../sync/fastsync'
+import { FullSynchronizer } from '../sync/fullsync'
 import { EthProtocol } from '../net/protocol/ethprotocol'
 import { LesProtocol } from '../net/protocol/lesprotocol'
 import { Peer } from '../net/peer/peer'
 import { Protocol, BoundProtocol } from '../net/protocol'
 
-interface FastEthereumServiceOptions extends EthereumServiceOptions {
+interface FullEthereumServiceOptions extends EthereumServiceOptions {
   /* Serve LES requests (default: false) */
   lightserv?: boolean
 }
@@ -14,20 +14,20 @@ interface FastEthereumServiceOptions extends EthereumServiceOptions {
  * Ethereum service
  * @memberof module:service
  */
-export class FastEthereumService extends EthereumService {
-  public synchronizer: FastSynchronizer
+export class FullEthereumService extends EthereumService {
+  public synchronizer: FullSynchronizer
   public lightserv: boolean
   /**
    * Create new ETH service
-   * @param {FastEthereumServiceOptions}
+   * @param {FullEthereumServiceOptions}
    */
-  constructor(options: FastEthereumServiceOptions) {
+  constructor(options: FullEthereumServiceOptions) {
     super(options)
 
     this.lightserv = options.lightserv ?? false
 
-    this.config.logger.info('Fast sync mode')
-    this.synchronizer = new FastSynchronizer({
+    this.config.logger.info('Full sync mode')
+    this.synchronizer = new FullSynchronizer({
       config: this.config,
       pool: this.pool,
       chain: this.chain,

lib/service/index.ts

@@ -4,5 +4,5 @@
 
 export * from './service'
 export * from './ethereumservice'
-export * from './fastethereumservice'
+export * from './fullethereumservice'
 export * from './lightethereumservice'

lib/sync/fastsync.ts lib/sync/fullsync.tslib/sync/fastsync.ts renamed to lib/sync/fullsync.ts

@@ -6,10 +6,10 @@ import { Synchronizer, SynchronizerOptions } from './sync'
 import { BlockFetcher } from './fetcher'
 
 /**
- * Implements an ethereum fast sync synchronizer
+ * Implements an ethereum full sync synchronizer
  * @memberof module:sync
  */
-export class FastSynchronizer extends Synchronizer {
+export class FullSynchronizer extends Synchronizer {
   private blockFetcher: BlockFetcher | null
 
   constructor(options: SynchronizerOptions) {
@@ -22,7 +22,7 @@ export class FastSynchronizer extends Synchronizer {
    * @return {string} type
    */
   get type(): string {
-    return 'fast'
+    return 'full'
   }
 
   /**
@@ -113,13 +113,10 @@ export class FastSynchronizer extends Synchronizer {
     // @ts-ignore: error: The operand of a 'delete' operator must be optional
     delete this.blockFetcher
     return true
-
-    // TO DO: Fetch state trie as well
   }
 
   /**
-   * Fetch all blocks from current height up to highest found amongst peers and
-   * fetch entire recent state trie
+   * Fetch all blocks from current height up to highest found amongst peers
    * @return Resolves with true if sync successful
    */
   async sync(): Promise<boolean> {