The web3-providers-ipc package is part of the Web3.js library and provides an IPC (Inter-Process Communication) provider for connecting to Ethereum nodes. This allows for communication with an Ethereum node over IPC, which is generally faster and more secure than HTTP or WebSocket connections.

What are web3-providers-ipc's main functionalities?

Create an IPC Provider

This feature allows you to create an IPC provider to connect to an Ethereum node using IPC. The path to the IPC file and the net module are required to establish the connection.

const Web3 = require('web3');
const net = require('net');
const web3 = new Web3(new Web3.providers.IpcProvider('/path/to/geth.ipc', net));

Send a Synchronous Request

This feature demonstrates how to send a synchronous request to get the latest block number from the Ethereum node using the IPC provider.

const Web3 = require('web3');
const net = require('net');
const web3 = new Web3(new Web3.providers.IpcProvider('/path/to/geth.ipc', net));

web3.eth.getBlockNumber().then(console.log);

Handle Provider Events

This feature shows how to handle events such as 'connect' and 'error' when using the IPC provider. This is useful for monitoring the connection status and handling errors.

const Web3 = require('web3');
const net = require('net');
const provider = new Web3.providers.IpcProvider('/path/to/geth.ipc', net);

provider.on('connect', () => {
  console.log('Connected to IPC provider');
});

provider.on('error', (error) => {
  console.error('IPC provider error:', error);
});

Other packages similar to web3-providers-ipc

Changelog

Source

[1.2.7]

Added

Add revert reason support to sendSignedTransaction (#3345)
ENS module extended with the possibility to add a custom registry (#3301)
Missing ENS Registry methods and Resolver.supportsInterface method added (#3325)
Add optional gas type to AbiItem typescript definitions (for ABIs generated by Vyper) (#3437)
Add görli testnet ENS registry to the known registries (#3252)
Add auto-reconnect option for Websockets (#3092, #1085, #1391, #1558, #1852, #1646)

Changed

Ensure '0x' prefix is existing for Accounts.sign and Accounts.privateKeyToAccount (#3041)
Repository cleanup (#3443)
- Removed old docs/_build folder
- Removed old bower and meteor artifacts
- Moved logo assets to own folder
- Moved github assets to own folder
- Remove @types/node from (non-dev) dependency tree (#3965, #3227)
Please note: Geth v1.9.12 contains a breaking change for eth_call that will not default to your first account anymore if from is not set. If a sender is not explicitly defined, the eth_call will be executed from address(0). (#3467)
- This was done to avoid the same input behaving differently in different environments. You should never do eth_call without explicitly setting a sender.
- This means that if you're calling view methods that refer to a msg.sender without explicitly setting a from address in your request options, you may see unexpected behavior.
- In web3.js, the from address can be specified on a per-call basis or by setting the defaultAccount property.

Fixed

Add missing subscription.on('connected') TS type definition (#3319)
Add missing bignumber.js dependency for TS types (#3386)
Upgrade swarm-js to 0.1.40 to remove npm vulnerability warning (#3399)
Upgrade devDeps to resolve security warnings (#3464)
- dtslint 0.4.2 => 3.4.1
- definitelytyped-header-parser 1.0.1 => 3.9.0
Race-condition when subscribing to historical logs as first client request (#3389)
Fix crash when using Web-Workers by removing any-promise dependency (#3377 #2211 #1774)
MaxListenersExceededWarning event emitter warning mitigated (#1648)

Readme

Source