web3-providers-ipc

What is web3-providers-ipc?

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

web3-providers-http

The web3-providers-http package provides an HTTP provider for connecting to Ethereum nodes. Unlike IPC, HTTP is more widely supported and easier to set up but may be slower and less secure. It is suitable for scenarios where IPC is not available or practical.

web3-providers-ws

The web3-providers-ws package provides a WebSocket provider for connecting to Ethereum nodes. WebSocket connections offer real-time communication and are more efficient than HTTP for certain use cases. However, they may not be as secure as IPC connections.

ethers

The ethers package is a complete and compact library for interacting with the Ethereum blockchain. It provides various providers, including JSON-RPC over HTTP and WebSocket, but does not natively support IPC. It is known for its simplicity and ease of use compared to Web3.js.

README

web3-providers-ipc

This is an IPC provider sub-package for web3.js.

Please read the documentation for more.

Installation

Node.js

npm install web3-providers-ipc

Usage

const Web3IpcProvider = require('web3-providers-ipc');
const net = require(net);

const ipc = new Web3IpcProvider('/Users/me/Library/Ethereum/geth.ipc', net);

Types

All the TypeScript typings are placed in the types folder.

Changelog

[1.6.1]

Added

• Support for eth_createAccessList as both an rpc call (web3.eth.createAccessList) and property of contract method wrappers (contractInstance.methods.getValue().createAccessList) (#4332)

Changed

• Not considering tx.chainId if tx.common.customChain.chainId is provided for web3.eth.accounts.signTransaction function (#4293)
• Added missing PromiEvent handler types (#4194)
• Updated README to include webpack 5 angular support instructions (#4174)
• Updated the documentation for the Web3.utils, removed context for _ (underscore lib) (#4403)
• Emit subscription id with connect event when creating a subscription (#4300)
• Introduced new configuration "blockHeaderTimeout" for waiting of block headers for transaction receipt (#3891)
• Format block.baseFeePerGas to number (#4330)
• Correct web3-eth-personal.sendTransaction example in documentation (#4409)
• Updated README to include webpack 5 angular support instructions (#4174)

Fixed

• Fix 1.6.1 build size issue with removing static asset files (#4506)
• Correct web3.rst example in documentation (#4511)
• Correct BlockHeader typing (receiptRoot -> receiptsRoot) (#4452)