_service_lightethereumservice_.lightethereumservice.md

ethereumjs-client › "service/lightethereumservice" › LightEthereumService

Class: LightEthereumService

Ethereum service

memberof module:service

Hierarchy

↳ EthereumService

↳ LightEthereumService

Index

Constructors

• constructor

Properties

• chain
• config
• flow
• interval
• opened
• pool
• running
• synchronizer
• timeout

Accessors

• name
• protocols

Methods

• addListener
• close
• emit
• eventNames
• getMaxListeners
• handle
• listenerCount
• listeners
• off
• on
• once
• open
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• setMaxListeners
• start
• stop

Constructors

constructor

+ new LightEthereumService(options: EthereumServiceOptions): LightEthereumService

Overrides EthereumService.constructor

Defined in lib/service/lightethereumservice.ts:11

Create new ETH service

Parameters:

Name	Type	Description
options	EthereumServiceOptions	constructor parameters

Returns: LightEthereumService

Properties

chain

• chain: Chain

Inherited from EthereumService.chain

Defined in lib/service/ethereumservice.ts:27

---

config

• config: Config

Inherited from Service.config

Defined in lib/service/service.ts:17

---

flow

• flow: FlowControl

Inherited from EthereumService.flow

Defined in lib/service/ethereumservice.ts:26

---

interval

• interval: number

Inherited from EthereumService.interval

Defined in lib/service/ethereumservice.ts:28

---

opened

• opened: boolean

Inherited from Service.opened

Defined in lib/service/service.ts:18

---

pool

• pool: PeerPool

Inherited from Service.pool

Defined in lib/service/service.ts:20

---

running

• running: boolean

Inherited from Service.running

Defined in lib/service/service.ts:19

---

synchronizer

• synchronizer: LightSynchronizer

Overrides EthereumService.synchronizer

Defined in lib/service/lightethereumservice.ts:11

---

timeout

• timeout: number

Inherited from EthereumService.timeout

Defined in lib/service/ethereumservice.ts:29

Accessors

Protected name

• get name(): string

Inherited from EthereumService.name

Overrides Service.name

Defined in lib/service/ethereumservice.ts:50

Service name

type {string}

Returns: string

---

protocols

• get protocols(): LesProtocol[]

Overrides Service.protocols

Defined in lib/service/lightethereumservice.ts:33

Returns all protocols required by this service

Returns: LesProtocol[]

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

---

close

▸ close(): Promise‹void›

Inherited from Service.close

Defined in lib/service/service.ts:96

Close service.

Returns: Promise‹void›

---

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

---

handle

▸ handle(_message: any, _protocol: string, _peer: Peer): Promise‹void›

Overrides Service.handle

Defined in lib/service/lightethereumservice.ts:44

Handles incoming message from connected peer

Parameters:

Name	Type
_message	any
_protocol	string
_peer	Peer

Returns: Promise‹void›

---

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‹undefined | false›

Inherited from EthereumService.open

Overrides Service.open

Defined in lib/service/ethereumservice.ts:58

Open eth service. Must be called before service is started

Returns: Promise‹undefined | false›

---

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 EthereumService.start

Overrides Service.start

Defined in lib/service/ethereumservice.ts:74

Starts service and ensures blockchain is synchronized. Returns a promise that resolves once the service is started and blockchain is in sync.

Returns: Promise‹void | boolean›

---

stop

▸ stop(): Promise‹void | boolean›

Inherited from EthereumService.stop

Overrides Service.stop

Defined in lib/service/ethereumservice.ts:86

Stop service. Interrupts blockchain synchronization if its in progress.

Returns: Promise‹void | boolean›