Ethereum JavaScript API
Go to file
Marek Kotewicz 75e92c8048 Merge branch 'master' into develop 2015-03-07 16:48:30 +01:00
dist Merge branch 'master' into develop 2015-03-06 12:05:40 +01:00
example changed contract API 2015-02-24 10:36:54 +01:00
lib Merge branch 'master' into develop 2015-03-06 12:05:40 +01:00
test Merge branch 'master' into develop 2015-03-07 16:48:30 +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 Helping travis a bit... old boy! 2015-03-06 21:37:44 +01:00
LICENSE Converted to node module 2014-11-05 19:46:01 +02:00
README.md Merge branch 'master' into develop 2015-03-06 12:05:40 +01:00
bower.json Merge branch 'master' into develop 2015-03-04 00:48:33 +01:00
gulpfile.js Move browserify transforms to package.json 2015-02-27 15:47:41 -08:00
index.js providermanager -> requestmanager 2015-02-06 00:02:14 +01:00
karma.conf.js karma 2015-03-06 10:06:50 +01:00
package.json Merge branch 'master' into develop 2015-03-07 16:48:30 +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

NPM version Build Status dependency status dev dependency statusCoverage Status

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
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