Note

This documentation is under construction and the web3.js 1.0 stable version isn’t released. If your using a version v0.x.x of web3.js then please have a look at github.com/ethereum/wiki/wiki/JavaScript-API.

web3.*.net

The web3-net package allows you to interact with the Ethereum nodes network properties.

import Web3 from 'web3';
import {Net} from 'web3-net';

// "Personal.providers.givenProvider" will be set if in an Ethereum supported browser.
const net = new Net(Web3.givenProvider || 'ws://some.local-or-remote.node:8546', null, options);


// or using the web3 umbrella package
const web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546', null, options);

// -> web3.eth.net
// -> web3.shh.net

getId

web3.eth.net.getId([callback])
web3.shh.net.getId([callback])

Gets the current network ID.

Parameters

none

Returns

Promise returns Number: The network ID.

Example

web3.eth.net.getId().then(console.log);
> 1

isListening

web3.eth.net.isListening([callback])
web3.shh.net.isListening([callback])

Checks if the node is listening for peers.

Parameters

none

Returns

Promise returns Boolean

Example

web3.eth.isListening().then(console.log);
> true

getPeerCount

web3.eth.net.getPeerCount([callback])
web3.shh.net.getPeerCount([callback])

Get the number of peers connected to.

Parameters

none

Returns

Promise returns Number

Example

web3.eth.getPeerCount().then(console.log);
> 25