PREVIEW RELEASE This is a beta preview release with breaking changes! The current stable version is 0.20.0

web3.js - Ethereum JavaScript API

This is the Ethereum JavaScript API which connects to the Generic JSON RPC spec.

You need to run a local or remote Ethereum node to use this library.

Please read the documentation for more.

Installation

Node.js

npm install web3

Meteor.js

Note: works only in the Browser for now. (PRs welcome)

meteor add ethereum:web3

In the Browser

Build and include dist/web3.min.js in your html file.

Usage

Use the Web3 object directly from global namespace:

var web3 = new Web3('ws://localhost:8546');
console.log(Web3);
> {
    eth: ... ,
    shh: ... ,
    utils: ...,
    ...
}

Additionally you can set a provider using web3.setProvider() (e.g. WebsocketProvider)

web3.setProvider('ws://localhost:8546');
// or
web3.setProvider(new Web3.providers.WebsocketProvider('ws://localhost:8546'));

There you go, now you can use it:

web3.eth.getAccounts()
.then(console.log);

Documentation

Documentation can be found at read the docs

Building

Requirements

• Node.js
• npm

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Building (gulp)

npm run-script build

This will put all the browser build files into the dist folder.

Testing (mocha)

npm test