web3-providers-ipc
Advanced tools
Package description
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.
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);
});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.
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.
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.
Changelog
[1.3.4]
fromBlock option for logs subscriptions (defaults to latest) (#3883)web3-eth2-base to web3-eth2-core and web3-eth2-beacon to web3-eth2-beaconchain (#3833)ts-node from version ^8.10.2 to ^9.0.0 (#3856)npm audit fix which fixed 4 vulnerabilities (#3856)web3-eth2-beaconchain type declarations (#3859) and (#3865)IBaseAPISchema and IBaseAPIMethodSchema to index.d.ts for web3-eth2-core (#3878)web3-eth2-core (#3878)notImplemented flag from ETH2 Beacon Chain package methods schema (#3861)IETH2BeaconChain interface in favor of exporting a class type: ETH2BeaconChain (#3878)index.d.ts files in favor of types.ts for web3-eth2-core and web3-eth2-beaconchain (#3878)schema.ts from web3-eth2-core (#3878)dtslint npm command from web3-eth2-core and web3-eth2-beaconchain as index.d.ts files were removed (#3878)ETH2Core class export to index.d.ts for web3-eth2-core (#3878)Readme
This is an IPC provider sub-package for web3.js.
Please read the documentation for more.
npm install web3-providers-ipc
const Web3IpcProvider = require('web3-providers-ipc');
const net = require(net);
const ipc = new Web3IpcProvider('/Users/me/Library/Ethereum/geth.ipc', net);
All the TypeScript typings are placed in the types folder.
FAQs
IPC provider for Web3 4.x.x
The npm package web3-providers-ipc receives a total of 461,668 weekly downloads. As such, web3-providers-ipc popularity was classified as popular.
We found that web3-providers-ipc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.