-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
net.ts
73 lines (66 loc) · 2.24 KB
/
net.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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
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/>.
*/
import { Web3Context } from 'web3-core';
import { DataFormat, DEFAULT_RETURN_FORMAT, Web3NetAPI } from 'web3-types';
import * as rpcMethodsWrappers from './rpc_method_wrappers.js';
export class Net extends Web3Context<Web3NetAPI> {
/**
* Gets the current network ID
*
* @param returnFormat - Return format
* @returns A Promise of the network ID.
* @example
* ```ts
* const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
* await net.getId();
* > 1
* ```
*/
public async getId<ReturnFormat extends DataFormat = typeof DEFAULT_RETURN_FORMAT>(
returnFormat: ReturnFormat = DEFAULT_RETURN_FORMAT as ReturnFormat,
) {
return rpcMethodsWrappers.getId(this, returnFormat);
}
/**
* Get the number of peers connected to.
*
* @param returnFormat - Return format
* @returns A promise of the number of the peers connected to.
* @example
* ```ts
* const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
* await net.getPeerCount();
* > 0
* ```
*/
public async getPeerCount<ReturnFormat extends DataFormat = typeof DEFAULT_RETURN_FORMAT>(
returnFormat: ReturnFormat = DEFAULT_RETURN_FORMAT as ReturnFormat,
) {
return rpcMethodsWrappers.getPeerCount(this, returnFormat);
}
/**
* Check if the node is listening for peers
*
* @returns A promise of a boolean if the node is listening to peers
* @example
* ```ts
* const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
* await net.isListening();
* > true
* ```
*/
public async isListening() {
return rpcMethodsWrappers.isListening(this);
}
}