Ethereum JavaScript API
Go to file
Marek Kotewicz 33a3fc7bcd generic integration tests 2015-03-23 14:08:59 +01:00
dist inputFormatter is an aray of functions 2015-03-23 13:42:36 +01:00
example changed bundle name web3 -> ethereum.js 2015-03-16 10:31:11 +01:00
lib inputFormatter is an aray of functions 2015-03-23 13:42:36 +01:00
test generic integration tests 2015-03-23 14:08:59 +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
.versions add net object 2015-03-02 16:29:23 +01:00
LICENSE Converted to node module 2014-11-05 19:46:01 +02:00
README.md changed bundle name web3 -> ethereum.js 2015-03-16 10:31:11 +01:00
bower.json fixed polling bug 0.1.2 2015-03-11 14:28:52 +01:00
gulpfile.js expose bignumber.js 2015-03-16 10:46:37 +01:00
index.js changed project structure 2015-03-08 18:18:52 +01:00
karma.conf.js Use browserify's 'browser' field instead of 'envify' & 'unreachable-branch-transform to', plus always include 'bignumber.js' since it is needed in the browser. 2015-03-16 08:08:29 +00:00
package-init.js fixed meteor package 2015-03-16 10:48:19 +01:00
package.js fixed meteor package 2015-03-16 10:48:19 +01:00
package.json node-sandbox, tests for httpprovider, request manager refactor in progress 2015-03-21 21:59:38 +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, for bower and component as an embeddable js and as a meteor.js package.

NPM version Build Status dependency status dev dependency statusCoverage Status

You need to run a local ethrereum node to use this library.

Documentation

Installation

Node.js

$ npm install ethereum.js

Meteor.js

$ meteor add ethereum:js

As Browser module

Bower

$ bower install ethereum.js

Component

$ component install ethereum/ethereum.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

Require the library (not required for the meteor package):

var web3 = require('ethereum.js');

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