Ethereum JavaScript API

Go to file

Marek Kotewicz b25486f2be Merge branch 'master' into develop Conflicts: dist/web3-light.min.js dist/web3.js.map dist/web3.min.js		2015-07-07 11:00:59 +02:00
dist	Merge branch 'master' into develop	2015-07-07 11:00:59 +02:00
example	example contract using array, fixed #185	2015-07-01 14:17:50 +02:00
lib	fixed build issues	2015-07-06 17:15:33 +02:00
test	add new contract.new behaviour	2015-07-06 16:47:49 +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	fixed #149	2015-03-30 09:11:56 +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	build files	2015-06-01 09:45:03 +02:00
LICENSE	update license per name change to web3.js	2015-06-10 10:04:05 -07:00
README.md	updated dependencies, gulp	2015-06-10 12:14:44 +02:00
bower.json	version 0.7.1	2015-06-30 13:07:28 +02:00
gulpfile.js	gulpfile changes	2015-06-26 08:56:18 +02:00
index.js	sendIBANTransaction && tests	2015-05-23 15:59:19 +02:00
package-init.js	fixed and tested meteor package init	2015-06-17 17:32:36 +02:00
package.js	version 0.7.1	2015-06-30 13:07:28 +02:00
package.json	changed my author email	2015-07-06 17:19:21 +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)
Include bignumber.js (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 (QtSyncProvider, 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);

For another example see example/index.html.

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

Testing (karma)

Karma allows testing within one or several browsers.

npm run-script karma # default browsers are Chrome and Firefox
npm run-script karma -- --browsers="Chrome,Safari" # custom browsers

Please note this repo is in it's early stage.

If you'd like to run a Http ethereum node check out cpp-ethereum.

Install ethereum and spawn a node:

eth -j