Skip to main content

Net

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.


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.

import {Net} from 'web3-net';

const net = new Net('https://mainnet.infura.io/v3/<YOURPROJID>');
console.log(await net.getId());

Hierarchy

  • Web3Context<Web3NetAPI>

    Net

Accessors

BatchRequest

get BatchRequest(): Object

Will return the Web3BatchRequest constructor.

Returns

Object

Inherited from

Web3Context.BatchRequest


blockHeaderTimeout

get blockHeaderTimeout(): number

The blockHeaderTimeout is used over socket-based connections. This option defines the amount seconds it should wait for 'newBlockHeaders' event before falling back to polling to fetch transaction receipt. Default is 10 seconds.

Returns

number

Inherited from

Web3Context.blockHeaderTimeout

set blockHeaderTimeout(val): void

Will set the blockHeaderTimeout

Parameters

NameType
valnumber

Returns

void

Inherited from

Web3Context.blockHeaderTimeout


contractDataInputFill

get contractDataInputFill(): "input" | "data" | "both"

The contractDataInputFill options property will allow you to set the hash of the method signature and encoded parameters to the property either data, input or both within your contract. This will affect the contracts send, call and estimateGas methods Default is data.

Returns

"input" | "data" | "both"

Inherited from

Web3Context.contractDataInputFill

set contractDataInputFill(val): void

Will set the contractDataInputFill

Parameters

NameType
val"input" | "data" | "both"

Returns

void

Inherited from

Web3Context.contractDataInputFill


currentProvider

get currentProvider(): undefined | Web3BaseProvider<API>

Will return the current provider. (The same as provider)

Returns

undefined | Web3BaseProvider<API>

Returns the current provider

Example

const web3Context = new Web3Context("http://localhost:8545");
console.log(web3Context.provider);
> HttpProvider {
clientUrl: 'http://localhost:8545',
httpProviderOptions: undefined
}

Inherited from

Web3Context.currentProvider

set currentProvider(provider): void

Will set the current provider. (The same as provider)

Parameters

NameTypeDescription
providerundefined | string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>SupportedProviders The provider to set

Returns

void

Example

 const web3Context = new Web3Context("http://localhost:8545");
web3Context.currentProvider = "ws://localhost:8545";
console.log(web3Context.provider);
> WebSocketProvider {
_eventEmitter: EventEmitter {
_events: [Object: null prototype] {},
_eventsCount: 0,
...
}

Inherited from

Web3Context.currentProvider


defaultAccount

get defaultAccount(): undefined | string

This default address is used as the default from property, if no from property is specified in for the following methods:

  • web3.eth.sendTransaction()
  • web3.eth.call()
  • myContract.methods.myMethod().call()
  • myContract.methods.myMethod().send()

Returns

undefined | string

Inherited from

Web3Context.defaultAccount

set defaultAccount(val): void

Will set the default account.

Parameters

NameType
valundefined | string

Returns

void

Inherited from

Web3Context.defaultAccount


defaultBlock

get defaultBlock(): BlockNumberOrTag

The default block is used for certain methods. You can override it by passing in the defaultBlock as last parameter. The default value is "latest".

  • web3.eth.getBalance()
  • web3.eth.getCode()
  • web3.eth.getTransactionCount()
  • web3.eth.getStorageAt()
  • web3.eth.call()
  • myContract.methods.myMethod().call()

Returns

BlockNumberOrTag

Inherited from

Web3Context.defaultBlock

set defaultBlock(val): void

Will set the default block.

  • A block number
  • "earliest" - String: The genesis block
  • "latest" - String: The latest block (current head of the blockchain)
  • "pending" - String: The currently mined block (including pending transactions)
  • "finalized" - String: (For POS networks) The finalized block is one which has been accepted as canonical by greater than 2/3 of validators
  • "safe" - String: (For POS networks) The safe head block is one which under normal network conditions, is expected to be included in the canonical chain. Under normal network conditions the safe head and the actual tip of the chain will be equivalent (with safe head trailing only by a few seconds). Safe heads will be less likely to be reorged than the proof of work network's latest blocks.

Parameters

NameType
valBlockNumberOrTag

Returns

void

Inherited from

Web3Context.defaultBlock


defaultCommon

get defaultCommon(): undefined | Common

Will get the default common property The default common property does contain the following Common object:

  • customChain - Object: The custom chain properties
    • name - string: (optional) The name of the chain
    • networkId - number: Network ID of the custom chain
    • chainId - number: Chain ID of the custom chain
  • baseChain - string: (optional) mainnet, goerli, kovan, rinkeby, or ropsten
  • hardfork - string: (optional) chainstart, homestead, dao, tangerineWhistle, spuriousDragon, byzantium, constantinople, petersburg, istanbul, berlin, or london Default is undefined.

Returns

undefined | Common

Inherited from

Web3Context.defaultCommon

set defaultCommon(val): void

Will set the default common property

Parameters

NameType
valundefined | Common

Returns

void

Inherited from

Web3Context.defaultCommon


defaultHardfork

get defaultHardfork(): string

Will return the default hardfork. Default is london The default hardfork property can be one of the following:

  • chainstart
  • homestead
  • dao
  • tangerineWhistle
  • spuriousDragon
  • byzantium
  • constantinople
  • petersburg
  • istanbul
  • berlin
  • london
  • 'arrowGlacier',
  • 'tangerineWhistle',
  • 'muirGlacier'

Returns

string

Inherited from

Web3Context.defaultHardfork

set defaultHardfork(val): void

Will set the default hardfork.

Parameters

NameType
valstring

Returns

void

Inherited from

Web3Context.defaultHardfork


enableExperimentalFeatures

get enableExperimentalFeatures(): Object

The enableExperimentalFeatures is used to enable trying new experimental features that are still not fully implemented or not fully tested or still have some related issues. Default is false for every feature.

Returns

Object

NameType
useRpcCallSpecificationboolean
useSubscriptionWhenCheckingBlockTimeoutboolean

Inherited from

Web3Context.enableExperimentalFeatures

set enableExperimentalFeatures(val): void

Will set the enableExperimentalFeatures

Parameters

NameType
valObject
val.useRpcCallSpecificationboolean
val.useSubscriptionWhenCheckingBlockTimeoutboolean

Returns

void

Inherited from

Web3Context.enableExperimentalFeatures


givenProvider

get givenProvider(): undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<never> | Web3BaseProvider<never> | SimpleProvider<never> | MetaMaskProvider<never>

Will return the givenProvider if available.

When using web3.js in an Ethereum compatible browser, it will set with the current native provider by that browser. Will return the given provider by the (browser) environment, otherwise undefined.

Returns

undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<never> | Web3BaseProvider<never> | SimpleProvider<never> | MetaMaskProvider<never>

Inherited from

Web3Context.givenProvider


handleRevert

get handleRevert(): boolean

The handleRevert options property returns the revert reason string if enabled for the following methods:

  • web3.eth.sendTransaction()
  • web3.eth.call()
  • myContract.methods.myMethod().call()
  • myContract.methods.myMethod().send() Default is false.

Note: At the moment handleRevert is only supported for sendTransaction and not for sendSignedTransaction

Returns

boolean

Inherited from

Web3Context.handleRevert

set handleRevert(val): void

Will set the handleRevert

Parameters

NameType
valboolean

Returns

void

Inherited from

Web3Context.handleRevert


ignoreGasPricing

get ignoreGasPricing(): boolean

Will get the ignoreGasPricing property. When true, the gasPrice, maxPriorityFeePerGas, and maxFeePerGas will not be autofilled in the transaction object. Useful when you want wallets to handle gas pricing.

Returns

boolean

Inherited from

Web3Context.ignoreGasPricing


provider

get provider(): undefined | Web3BaseProvider<API>

Will return the current provider.

Returns

undefined | Web3BaseProvider<API>

Returns the current provider

Example

const web3 = new Web3Context("http://localhost:8545");
console.log(web3.provider);
> HttpProvider {
clientUrl: 'http://localhost:8545',
httpProviderOptions: undefined
}

Inherited from

Web3Context.provider

set provider(provider): void

Will set the current provider.

Parameters

NameTypeDescription
providerundefined | string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>The provider to set Accepted providers are of type SupportedProviders

Returns

void

Example

 const web3Context = new web3ContextContext("http://localhost:8545");
web3Context.provider = "ws://localhost:8545";
console.log(web3Context.provider);
> WebSocketProvider {
_eventEmitter: EventEmitter {
_events: [Object: null prototype] {},
_eventsCount: 0,
...
}

Inherited from

Web3Context.provider


subscriptionManager

get subscriptionManager(): Web3SubscriptionManager<API, RegisteredSubs>

Will return the current subscriptionManager (Web3SubscriptionManager)

Returns

Web3SubscriptionManager<API, RegisteredSubs>

Inherited from

Web3Context.subscriptionManager


transactionBlockTimeout

get transactionBlockTimeout(): number

The transactionBlockTimeout is used over socket-based connections. This option defines the amount of new blocks it should wait until the first confirmation happens, otherwise the PromiEvent rejects with a timeout error. Default is 50.

Returns

number

Inherited from

Web3Context.transactionBlockTimeout

set transactionBlockTimeout(val): void

Will set the transactionBlockTimeout.

Parameters

NameType
valnumber

Returns

void

Inherited from

Web3Context.transactionBlockTimeout


transactionConfirmationBlocks

get transactionConfirmationBlocks(): number

This defines the number of blocks it requires until a transaction is considered confirmed. Default is 24.

Returns

number

Inherited from

Web3Context.transactionConfirmationBlocks

set transactionConfirmationBlocks(val): void

Will set the transactionConfirmationBlocks.

Parameters

NameType
valnumber

Returns

void

Inherited from

Web3Context.transactionConfirmationBlocks


transactionPollingInterval

get transactionPollingInterval(): number

Used over HTTP connections. This option defines the number of seconds between Web3 calls for a receipt which confirms that a transaction was mined by the network. Default is 1000 ms.

Returns

number

Inherited from

Web3Context.transactionPollingInterval

set transactionPollingInterval(val): void

Will set the transactionPollingInterval.

Parameters

NameType
valnumber

Returns

void

Inherited from

Web3Context.transactionPollingInterval


transactionPollingTimeout

get transactionPollingTimeout(): number

Used over HTTP connections. This option defines the number of seconds Web3 will wait for a receipt which confirms that a transaction was mined by the network. Note: If this method times out, the transaction may still be pending. Default is 750 seconds (12.5 minutes).

Returns

number

Inherited from

Web3Context.transactionPollingTimeout

set transactionPollingTimeout(val): void

Will set the transactionPollingTimeout.

Parameters

NameType
valnumber

Returns

void

Inherited from

Web3Context.transactionPollingTimeout


transactionReceiptPollingInterval

get transactionReceiptPollingInterval(): undefined | number

The transactionPollingInterval is used over HTTP connections. This option defines the number of seconds between Web3 calls for a receipt which confirms that a transaction was mined by the network. Default is undefined

Returns

undefined | number

Inherited from

Web3Context.transactionReceiptPollingInterval

set transactionReceiptPollingInterval(val): void

Will set the transactionReceiptPollingInterval

Parameters

NameType
valundefined | number

Returns

void

Inherited from

Web3Context.transactionReceiptPollingInterval


transactionSendTimeout

get transactionSendTimeout(): number

The time used to wait for Ethereum Node to return the sent transaction result. Note: If the RPC call stuck at the Node and therefor timed-out, the transaction may still be pending or even mined by the Network. We recommend checking the pending transactions in such a case. Default is 750 seconds (12.5 minutes).

Returns

number

Inherited from

Web3Context.transactionSendTimeout

set transactionSendTimeout(val): void

Will set the transactionSendTimeout.

Parameters

NameType
valnumber

Returns

void

Inherited from

Web3Context.transactionSendTimeout

Methods

extend

extend(extendObj): this

This method allows extending the web3 modules. Note: This method is only for backward compatibility, and It is recommended to use Web3 v4 Plugin feature for extending web3.js functionality if you are developing something new.

Parameters

NameType
extendObjExtensionObject

Returns

this

Inherited from

Web3Context.extend


getId

getId<ReturnFormat>(returnFormat?): Promise<NumberTypes[ReturnFormat["number"]]>

Gets the current network ID

Type parameters

NameType
ReturnFormatextends DataFormat = { bytes: HEX ; number: BIGINT }

Parameters

NameTypeDescription
returnFormatReturnFormatReturn format

Returns

Promise<NumberTypes[ReturnFormat["number"]]>

A Promise of the network ID.

Example

const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
await net.getId();
> 1

getPeerCount

getPeerCount<ReturnFormat>(returnFormat?): Promise<NumberTypes[ReturnFormat["number"]]>

Get the number of peers connected to.

Type parameters

NameType
ReturnFormatextends DataFormat = { bytes: HEX ; number: BIGINT }

Parameters

NameTypeDescription
returnFormatReturnFormatReturn format

Returns

Promise<NumberTypes[ReturnFormat["number"]]>

A promise of the number of the peers connected to.

Example

const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
await net.getPeerCount();
> 0

isListening

isListening(): Promise<boolean>

Check if the node is listening for peers

Returns

Promise<boolean>

A promise of a boolean if the node is listening to peers

Example

const net = new Net(Net.givenProvider || 'ws://some.local-or-remote.node:8546');
await net.isListening();
> true

link<T>(parentContext): void

Link current context to another context.

Type parameters

NameType
Textends Web3Context<unknown, any, T>

Parameters

NameType
parentContextT

Returns

void

Inherited from

Web3Context.link


setProvider

setProvider(provider?): boolean

Will set the provider.

Parameters

NameTypeDescription
provider?string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<Web3NetAPI> | Web3BaseProvider<Web3NetAPI> | SimpleProvider<Web3NetAPI> | MetaMaskProvider<Web3NetAPI>SupportedProviders The provider to set

Returns

boolean

Returns true if the provider was set

Inherited from

Web3Context.setProvider


use

use<T, T2>(ContextRef, ...args): T

Use to create new object of any type extended by Web3Context and link it to current context. This can be used to initiate a global context object and then use it to create new objects of any type extended by Web3Context.

Type parameters

NameType
Textends Web3Context<unknown, any, T>
T2extends unknown[]

Parameters

NameType
ContextRefWeb3ContextConstructor<T, T2>
...args[...T2[]]

Returns

T

Inherited from

Web3Context.use