ethereumjs-client › "node" › Node

Class: Node

Represents the top-level ethereum node, and is responsible for managing the lifecycle of included services.

memberof module:node

Hierarchy

• EventEmitter

  ↳ Node

Index

Constructors

• constructor

Properties

• config
• opened
• services
• started
• defaultMaxListeners
• errorMonitor

Methods

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

Constructors

constructor

+ new Node(options: NodeOptions): Node

Overrides void

Defined in lib/node.ts:35

Create new node

Parameters:

Name	Type
options	NodeOptions

Returns: Node

Properties

config

• config: Config

Defined in lib/node.ts:30

---

opened

• opened: boolean

Defined in lib/node.ts:34

---

services

• services: (FullEthereumService‹› | LightEthereumService‹›)[]

Defined in lib/node.ts:32

---

started

• started: boolean

Defined in lib/node.ts:35

---

Static defaultMaxListeners

▪ defaultMaxListeners: number

Inherited from Sender.defaultMaxListeners

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

---

Static errorMonitor

▪ errorMonitor: keyof symbol

Inherited from Sender.errorMonitor

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

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

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

---

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

---

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›

Defined in lib/node.ts:65

Open node. Must be called before node 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

---

server

▸ server(name: string): undefined | RlpxServer‹› | Libp2pServer‹›

Defined in lib/node.ts:129

Returns the server with the specified name.

Parameters:

Name	Type	Description
name	string	name of server

Returns: undefined | RlpxServer‹› | Libp2pServer‹›

---

service

▸ service(name: string): undefined | FullEthereumService‹› | LightEthereumService‹›

Defined in lib/node.ts:120

Returns the service with the specified name.

Parameters:

Name	Type	Description
name	string	name of service

Returns: undefined | FullEthereumService‹› | LightEthereumService‹›

---

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

Defined in lib/node.ts:93

Starts node and all services and network servers.

Returns: Promise‹undefined | false›

---

stop

▸ stop(): Promise‹undefined | false›

Defined in lib/node.ts:106

Stops node and all services and network servers.

Returns: Promise‹undefined | false›

---

Static listenerCount

▸ listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Sender.listenerCount

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

deprecated since v4.0.0

Parameters:

Name	Type
emitter	EventEmitter
event	string | symbol

Returns: number