Package Exports

web3
web3/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (web3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

PREVIEW RELEASE This is a beta preview release. The current stable version is 0.20.0

web3.js has moved from 0.x.x to 1.x.x. This is a major refactor, we will provide a guide on how to upgrade in the future.

web3.js - Ethereum JavaScript API

This is the Ethereum compatible JavaScript API which implements the Generic JSON RPC spec. It's available on npm as a node module, for bower and component as an embeddable js and as a meteor.js package.

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

Documentation

Installation

Node.js

npm install web3

Meteor.js

meteor add ethereum:web3

As Browser module

Bower

bower install web3

Or 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

Testing (mocha)

npm test