Ethereum JavaScript API
Go to file
Fabian Vogelsteller 05b3b4b534 Merge pull request #462 from SafeMarket/expose-bignumber
expose BigNumber on web3 instances
2016-06-27 15:18:12 +02:00
dist expose BigNumber on web3 instances 2016-06-23 13:24:34 -04:00
example updated examples 2015-10-21 12:02:00 +08:00
lib expose BigNumber on web3 instances 2016-06-23 13:24:34 -04:00
test also passes options argument 2016-03-04 00:58:00 +01: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 add Meteor server fix 2015-07-30 15:44:51 +02:00
.jshintrc sendIBANTransaction && tests 2015-05-23 15:59:19 +02:00
.npmignore Refactoring 2014-11-06 22:51:37 +02:00
.travis.yml bump node versions for travis 2015-10-06 01:00:06 +02:00
.versions added new version file 2016-03-02 11:15:04 +01:00
LICENSE update license per name change to web3.js 2015-06-10 10:04:05 -07:00
README.md Fix incorrect filename in documentation 2016-06-27 20:37:18 +08:00
bower.json bumped version 2016-05-12 16:48:21 +02:00
gulpfile.js fixed #318, upgraded del package to 2.0.2 2015-10-05 09:25:25 +02:00
index.js add currentProvider back and fixed index.js 2015-10-08 11:20:45 +02:00
package-init.js add currentProvider back and fixed index.js 2015-10-08 11:20:45 +02:00
package.js bumped version 2016-05-12 16:48:21 +02:00
package.json bumped version 2016-05-12 16:48:21 +02:00
styleguide.md use 4 spaces instead of 2 2015-07-16 13:42:30 +02:00

README.md

Migration 0.13.0 -> 0.14.0

web3.js version 0.14.0 supports multiple instances of web3 object. To migrate to this version, please follow the guide:

-var web3 = require('web3');
+var Web3 = require('web3');
+var web3 = new Web3();

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 statusCoverage StatusStories 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.

Contribute!

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