2024-10-15 23:05:53 +03:00

127 lines
4.8 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Net = void 0;
/*
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/>.
*/
const web3_core_1 = require("web3-core");
const rpcMethodsWrappers = __importStar(require("./rpc_method_wrappers.js"));
/**
* Net class allows you to interact with an Ethereum node’s network properties.
* For using Net package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that Net features can be used.
* ```ts
*
* import { Web3 } from 'web3';
* const web3 = new Web3('https://mainnet.infura.io/v3/<YOURPROJID>');
*
* console.log(await web3.eth.net.getId());
*
* ```
* For using individual package install `web3-net` packages using: `npm i web3-net` or `yarn add web3-net`.
*
* ```ts
* import {Net} from 'web3-net';
*
* const net = new Net('https://mainnet.infura.io/v3/<YOURPROJID>');
* console.log(await net.getId());
* ```
*/
class Net extends web3_core_1.Web3Context {
/**
* 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
* ```
*/
getId(returnFormat = this.defaultReturnFormat) {
return __awaiter(this, void 0, void 0, function* () {
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
* ```
*/
getPeerCount(returnFormat = this.defaultReturnFormat) {
return __awaiter(this, void 0, void 0, function* () {
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
* ```
*/
isListening() {
return __awaiter(this, void 0, void 0, function* () {
return rpcMethodsWrappers.isListening(this);
});
}
}
exports.Net = Net;
//# sourceMappingURL=net.js.map