@sebasgoldberg/hardhat-wsprovider
v0.1.1
Published
Hardhat plugin to enable web socket provider.
Downloads
3,751
Maintainers
Readme
hardhat-wsprovider
This plug-in it is used to add getProvider
function, that supports web socket providers, to hre.
Hardhat web socket provider plugin.
What
This plugin will help you with:
- If you want to use web socket providers.
- If you want to use http socket provider with different polling interval.
Installation
npm install @sebasgoldberg/hardhat-wsprovider
Import the plugin in your hardhat.config.js
:
require("@sebasgoldberg/hardhat-wsprovider");
Or if you are using TypeScript, in your hardhat.config.ts
:
import "@sebasgoldberg/hardhat-wsprovider";
Environment extensions
This plugin extends the Hardhat Runtime Environment by adding an getProvider
function.
Here is an example to get the configured provider in hardhat network config (supports web sockets!).
// ...
const p: JsonRpcProvider = this.hre.getProvider()
// ...
In case it is used a network configured without web socket protocol, getProvider()
returns hre.ethers.provider
(if not configured pollingInterval
), so it is safe to use always getProvider()
.
Configuration
This plug in adds pollingInterval
to the hardhat http network (user) configuration.
In case it is defined pollingInterval
for an http(s) url, getProvider()
do not returns hre.ethers.provider
, instead it returns a JsonRpcProvider
configured with the specified pollingInterval
.