Socket
Socket
Sign inDemoInstall

web3-providers-ipc

Package Overview
Dependencies
44
Maintainers
2
Versions
380
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    web3-providers-ipc

Module to handle web3 RPC connections over IPC sockets.


Version published
Maintainers
2
Created

Package description

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

Changelog

Source

[1.2.1]

Fixed

  • websocket dependency fixed (#2971, #2976)
  • requestOptions added to WebsocketProvider (#2979)
  • Node >= v8.0.0 support (#2938)

Readme

Source

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);

FAQs

Last updated on 06 Aug 2019

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc