Ethereum JavaScript API

Go to file

Marek Kotewicz 2e9a41113e Merge pull request #71 from frozeman/apiOverhaul add formatter for gasPrice and balance		2015-02-26 11:50:01 +01:00
dist	fixed complexities	2015-02-26 10:56:04 +01:00
example	changed contract API	2015-02-24 10:36:54 +01:00
lib	fixed complexities	2015-02-26 10:56:04 +01:00
test	changed getCode to getData	2015-02-25 11:01:58 +01:00
.bowerrc	Converted to node module	2014-11-05 19:46:01 +02:00
.editorconfig	Updated bower.json & Readme	2014-11-05 22:33:28 +02:00
.gitignore	travis coveralls	2015-02-17 08:59:19 +01:00
.jshintrc	jshint is more strict	2015-02-25 15:53:28 +01:00
.npmignore	Refactoring	2014-11-06 22:51:37 +02:00
.travis.yml	travis coveralls	2015-02-16 22:53:04 +01:00
LICENSE	Converted to node module	2014-11-05 19:46:01 +02:00
README.md	Merge branch 'master' into develop	2015-02-23 15:44:28 +01:00
bower.json	merged with solved conflicts	2015-02-25 17:01:23 +01:00
gulpfile.js	jshint is more strict	2015-02-25 15:53:28 +01:00
index.js	providermanager -> requestmanager	2015-02-06 00:02:14 +01:00
package.json	merged with solved conflicts	2015-02-25 17:01:23 +01: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 and also for bower and component as an embeddable js

Installation

Node.js

npm install ethereum.js

For browser

Bower

bower install ethereum.js

Component

component install ethereum/ethereum.js

Include ethereum.min.js in your html file.
Include bignumber.js

Usage

Require the library:

var web3 = require('web3');

Set a provider (QtSyncProvider, HttpSyncProvider)

web3.setProvider(new web3.providers.HttpSyncProvider());

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
gulp (build)
mocha (tests)

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

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

If you'd like to run a WebSocket ethereum node check out go-ethereum.

To install ethereum and spawn a node:

go get github.com/ethereum/go-ethereum/ethereum
ethereum -ws -loglevel=4