Ethereum JavaScript API
Go to file
Fabian Vogelsteller cea6b3b173
added core to web3 docs
2017-03-29 20:44:43 +02:00
docs added core to web3 docs 2017-03-29 20:44:43 +02:00
examples Merge branch 'develop' into 1.0 2017-01-05 15:38:09 +01:00
packages added web3.extend docs 2017-03-28 17:55:34 +02:00
src added web3.extend docs 2017-03-28 17:55:34 +02:00
test added web3.extend docs 2017-03-28 17:55:34 +02:00
.bowerrc fixed #149 2015-03-30 09:11:56 +02:00
.editorconfig Updated bower.json & Readme 2014-11-05 22:33:28 +02:00
.gitignore changed version to beta 2017-02-28 10:24:14 +01:00
.jshintignore Modularize web3.js (#541) 2017-01-26 10:24:14 +01:00
.jshintrc Modularize web3.js (#541) 2017-01-26 10:24:14 +01:00
.npmignore changed version to beta 2017-02-28 10:24:14 +01:00
.travis.yml bump node versions for travis 2015-10-06 01:00:06 +02:00
.versions merged develop 0.18.0 2017-01-06 12:27:23 +01:00
LICENSE update license per name change to web3.js 2015-06-10 10:04:05 -07:00
README.md merged develop 2016-11-02 11:13:46 +01:00
bower.json removed SYNC, moved providers in separate packages 2017-02-28 16:02:54 +01:00
circle.yml CI - add circleCI config 2016-08-26 16:16:59 -07:00
gulpfile.js moved personal to eth.personal 2017-03-10 11:44:00 +01:00
lerna.json updated lerna 2017-03-22 12:06:21 +01:00
package-init.js moved to BN.js 2017-02-23 18:26:02 +01:00
package.js removed SYNC, moved providers in separate packages 2017-02-28 16:02:54 +01:00
package.json integrated ethjs-accounts 2017-03-24 11:37:24 +01:00
styleguide.md use 4 spaces instead of 2 2015-07-16 13:42:30 +02:00

README.md

web3.js has moved from 0.x.x to 1.x.x. This is a majore refactor, please read the following guide to update your dapp.

web3.js - Ethereum JavaScript API

Join the chat at https://gitter.im/ethereum/web3.js

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.

NPM version Build Status dependency status dev dependency status Coverage Status Stories in Ready

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

Component

component install ethereum/web3.js
  • Include web3.min.js in your html file. (not required for the meteor package)

Usage

Use the web3 object directly from global namespace:

console.log(web3); // {eth: .., shh: ...} // it's here!

Set a provider (HttpProvider)

web3.setProvider(new web3.providers.HttpProvider('http://localhost:8545'));

There you go, now you can use it:

var coinbase = web3.eth.coinbase;
var balance = web3.eth.getBalance(coinbase);

You can find more examples in example directory.

Documentation

Documentation can be found at read the docs

Requirements

  • Node.js
  • npm
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
sudo apt-get install nodejs-legacy

Building (gulp)

npm run-script build

Testing (mocha)

npm test