Ethereum JavaScript API

Go to file

debris 9aa23ae962 toUtf8, fromUtf8 aliases		2015-08-10 21:39:48 +02:00
dist	version 0.12.1	2015-08-10 21:08:35 +02:00
example	Merge branch 'cleanup'	2015-08-10 21:05:19 +02:00
lib	toUtf8, fromUtf8 aliases	2015-08-10 21:39:48 +02:00
test	use utf8 library for utf encoding/decoding	2015-08-10 21:38:27 +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	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	updated deps, removed unused karma	2015-06-25 11:50:22 +02:00
.versions	merged develop 0.7.0	2015-06-26 15:02:26 +02:00
LICENSE	update license per name change to web3.js	2015-06-10 10:04:05 -07:00
README.md	updated README.md	2015-07-13 15:58:38 +02:00
bower.json	version 0.12.1	2015-08-10 21:08:35 +02:00
gulpfile.js	fixed version regexp in gulpfile	2015-08-08 11:29:01 +02:00
index.js	refactored iban stuff	2015-08-06 17:11:15 +02:00
package-init.js	fixed and tested meteor package init	2015-06-17 17:32:36 +02:00
package.js	version 0.12.1	2015-08-10 21:08:35 +02:00
package.json	use utf8 library for utf encoding/decoding	2015-08-10 21:38:27 +02:00
styleguide.md	use 4 spaces instead of 2	2015-07-16 13:42:30 +02:00

README.md

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 ethrereum 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 ethereum.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