-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
index.ts
53 lines (46 loc) · 1.42 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
This file is part of web3.js.
web3.js is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
web3.js is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* The web3-net package allows you to interact with an Ethereum node’s network properties.
*
* ```ts
* import Net from 'web3-net';
*
* const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
* // or using the web3 umbrella package
* import Web3 from 'web3';
* const web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546');
*
* // -> web3.eth.net
*
* // get the ID of the network
* await web3.eth.net.getId();
* > 5777n
*
* // get the peer count
* await web3.eth.net.getPeerCount();
* > 0n
*
* // Check if the node is listening for peers
* await web3.eth.net.isListening();
* > true
* ```
*/
/**
*
*/
import { Net } from './net';
export * from './net';
export * from './rpc_method_wrappers';
export default Net;