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 a sub-package of web3.js.

This is a IPC provider for web3.js.

Please read the documentation for more.

Installation

Node.js

npm install web3-providers-ipc

In the Browser

Build running the following in the web3.js repository:

npm run-script build-all

Then include dist/web3-providers-ipc.js in your html file. This will expose the Web3IpcProvider object on the window object.

Usage

// in node.js
var Web3IpcProvider = require('web3-providers-ipc');
var net = require(net);

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

Types

All the TypeScript typings are placed in the types folder.

Changelog

[1.2.9]

Added

• Add sending and sent events for tx submissions (#3438)
• Add latestBlockHash arg to confirmation event handler payload (#3438)
• Make socket providers' max listeners threshold configurable (#3469)
• Documentation about testing & ci resources for Web3.js development (#3528)
• More detailed documentation about how to use method.encodeABI (#3549)
• Integration tests for transactionPollingTimeout (#3513)

Changed

• Websocket package from @web3-js/websocket@1.0.29 to websocket@1.0.31 (#3371)
• Upgrade @web3-js/scrypt-shim@0.1.0 to scrypt-js@3.0.1
• sendSignedTransaction revert handling synthesizes tx without network call (#3457)
• Make docs grammar more idiomatic, normalize punctuation (#3543)

Fixed

• Size property de-referencing crash when calling web3.eth.clearSubscriptions (#3527)
• Abi param encoding for tuple arrays (#3538)
• account.hashMessage with non-ASCII characters (#3523)
• Subscription support check in method confirmations loop (#3432)
• TS bindings for handleRevert added (#3452)
• Docs: spelling of pre-defined block number (#3539)
• Docs: missing defaultBlock param option in method.call description (#3558)