mirror of
https://github.com/embarklabs/web3.js.git
synced 2026-08-31 06:31:19 +00:00
51 lines
1.8 KiB
ReStructuredText
51 lines
1.8 KiB
ReStructuredText
.. include:: include_announcement.rst
|
|
|
|
===============
|
|
Getting Started
|
|
===============
|
|
|
|
The web3.js library is a collection of modules which contain specific functionality for the Ethereum ecosystem.
|
|
|
|
- The ``web3-eth`` is for the Ethereum blockchain and smart contracts
|
|
- The ``web3-shh`` is for the whisper protocol to communicate p2p and broadcast
|
|
- The ``web3-bzz`` is for the swarm protocol, the decentralized file storage
|
|
- The ``web3-utils`` contains useful helper functions for DApp developers.
|
|
|
|
|
|
.. _adding-web3:
|
|
|
|
Adding web3.js
|
|
==============
|
|
|
|
.. index:: npm
|
|
|
|
First you need to get web3.js into your project. This can be done using the following methods:
|
|
|
|
- npm: ``npm install web3``
|
|
|
|
After that you need to create a web3 instance and set a provider.
|
|
A Ethereum compatible browser will have a ``window.ethereum`` or ``web3.currentProvider`` available.
|
|
For web3.js, check ``Web3.givenProvider``. If this property is ``null`` you should connect to your own local or remote node.
|
|
|
|
.. code-block:: javascript
|
|
|
|
// in node.js use: const Web3 = require('web3');
|
|
|
|
// use the given Provider, e.g in the browser with Metamask, or instantiate a new websocket provider
|
|
const web3 = new Web3(Web3.givenProvider || 'ws://localhost:8546', null, {});
|
|
|
|
// or
|
|
const web3 = new Web3(Web3.givenProvider || new Web3.providers.WebsocketProvider('ws://localhost:8546'), null, {});
|
|
|
|
// Using the IPC provider in node.js
|
|
const net = require('net');
|
|
|
|
const web3 = new Web3('/Users/myuser/Library/Ethereum/geth.ipc', net, {}); // mac os path
|
|
// or
|
|
const web3 = new Web3(new Web3.providers.IpcProvider('/Users/myuser/Library/Ethereum/geth.ipc', net, {})); // mac os path
|
|
// on windows the path is: '\\\\.\\pipe\\geth.ipc'
|
|
// on linux the path is: '/users/myuser/.ethereum/geth.ipc'
|
|
|
|
|
|
That's it! now you can use the ``web3`` object.
|