_sync_fullsync_.fullsynchronizer.md

ethereumjs-client › "sync/fullsync" › FullSynchronizer

Class: FullSynchronizer

Implements an ethereum full sync synchronizer

memberof module:sync

Hierarchy

↳ Synchronizer

↳ FullSynchronizer

Index

Constructors

• constructor

Properties

• config

Accessors

• type

Methods

• addListener
• announced
• best
• emit
• eventNames
• getMaxListeners
• latest
• listenerCount
• listeners
• off
• on
• once
• open
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• setMaxListeners
• start
• stop
• sync
• syncWithPeer
• syncable

Constructors

constructor

+ new FullSynchronizer(options: SynchronizerOptions): FullSynchronizer

Overrides Synchronizer.constructor

Defined in lib/sync/fullsync.ts:13

Parameters:

Name	Type
options	SynchronizerOptions

Returns: FullSynchronizer

Properties

config

• config: Config

Inherited from Synchronizer.config

Defined in lib/sync/sync.ts:30

Accessors

type

• get type(): string

Overrides Synchronizer.type

Defined in lib/sync/fullsync.ts:24

Returns synchronizer type

Returns: string

type

Methods

addListener

▸ addListener(event: string | symbol, listener: function): this

Inherited from Sender.addListener

Defined in node_modules/@types/node/events.d.ts:62

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

announced

▸ announced(announcements: any[], _peer: Peer): Promise‹void›

Defined in lib/sync/fullsync.ts:133

Chain was updated

Parameters:

Name	Type	Description
announcements	any[]	new block hash announcements
_peer	Peer	-

Returns: Promise‹void›

---

best

▸ best(): Peer | undefined

Defined in lib/sync/fullsync.ts:42

Finds the best peer to sync with. We will synchronize to this peer's blockchain. Returns null if no valid peer is found

Returns: Peer | undefined

---

emit

▸ emit(event: string | symbol, ...args: any[]): boolean

Inherited from Sender.emit

Defined in node_modules/@types/node/events.d.ts:72

Parameters:

Name	Type
event	string | symbol
...args	any[]

Returns: boolean

---

eventNames

▸ eventNames(): Array‹string | symbol›

Inherited from Sender.eventNames

Defined in node_modules/@types/node/events.d.ts:77

Returns: Array‹string | symbol›

---

getMaxListeners

▸ getMaxListeners(): number

Inherited from Sender.getMaxListeners

Defined in node_modules/@types/node/events.d.ts:69

Returns: number

---

latest

▸ latest(peer: Peer): Promise‹any›

Defined in lib/sync/fullsync.ts:64

Get latest header of peer

Parameters:

Name	Type
peer	Peer

Returns: Promise‹any›

Resolves with header

---

listenerCount

▸ listenerCount(event: string | symbol): number

Inherited from Sender.listenerCount

Defined in node_modules/@types/node/events.d.ts:73

Parameters:

Name	Type
event	string | symbol

Returns: number

---

listeners

▸ listeners(event: string | symbol): Function[]

Inherited from Sender.listeners

Defined in node_modules/@types/node/events.d.ts:70

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

off

▸ off(event: string | symbol, listener: function): this

Inherited from Sender.off

Defined in node_modules/@types/node/events.d.ts:66

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

on

▸ on(event: string | symbol, listener: function): this

Inherited from Sender.on

Defined in node_modules/@types/node/events.d.ts:63

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

once

▸ once(event: string | symbol, listener: function): this

Inherited from Sender.once

Defined in node_modules/@types/node/events.d.ts:64

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

open

▸ open(): Promise‹void›

Overrides Synchronizer.open

Defined in lib/sync/fullsync.ts:144

Open synchronizer. Must be called before sync() is called

Returns: Promise‹void›

---

prependListener

▸ prependListener(event: string | symbol, listener: function): this

Inherited from Sender.prependListener

Defined in node_modules/@types/node/events.d.ts:75

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

prependOnceListener

▸ prependOnceListener(event: string | symbol, listener: function): this

Inherited from Sender.prependOnceListener

Defined in node_modules/@types/node/events.d.ts:76

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

rawListeners

▸ rawListeners(event: string | symbol): Function[]

Inherited from Sender.rawListeners

Defined in node_modules/@types/node/events.d.ts:71

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

removeAllListeners

▸ removeAllListeners(event?: string | symbol): this

Inherited from Sender.removeAllListeners

Defined in node_modules/@types/node/events.d.ts:67

Parameters:

Name	Type
event?	string | symbol

Returns: this

---

removeListener

▸ removeListener(event: string | symbol, listener: function): this

Inherited from Sender.removeListener

Defined in node_modules/@types/node/events.d.ts:65

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

setMaxListeners

▸ setMaxListeners(n: number): this

Inherited from Sender.setMaxListeners

Defined in node_modules/@types/node/events.d.ts:68

Parameters:

Name	Type
n	number

Returns: this

---

start

▸ start(): Promise‹void | boolean›

Inherited from Synchronizer.start

Defined in lib/sync/sync.ts:87

Start synchronization

Returns: Promise‹void | boolean›

---

stop

▸ stop(): Promise‹boolean›

Overrides Synchronizer.stop

Defined in lib/sync/fullsync.ts:157

Stop synchronization. Returns a promise that resolves once its stopped.

Returns: Promise‹boolean›

---

sync

▸ sync(): Promise‹boolean›

Defined in lib/sync/fullsync.ts:122

Fetch all blocks from current height up to highest found amongst peers

Returns: Promise‹boolean›

Resolves with true if sync successful

---

syncWithPeer

▸ syncWithPeer(peer?: Peer): Promise‹boolean›

Defined in lib/sync/fullsync.ts:78

Sync all blocks and state from peer starting from current height.

Parameters:

Name	Type	Description
peer?	Peer	remote peer to sync with

Returns: Promise‹boolean›

Resolves when sync completed

---

syncable

▸ syncable(peer: Peer): boolean

Overrides Synchronizer.syncable

Defined in lib/sync/fullsync.ts:34

Returns true if peer can be used for syncing

Parameters:

Name	Type
peer	Peer

Returns: boolean