Skip to content
Ethereum Compatible JavaScript API
JavaScript HTML
Find file
Pull request Compare This branch is 394 commits ahead of debris:master.
Failed to load latest commit information.
dist
example
lib
test
.bowerrc Converted to node module
.editorconfig
.gitignore
.jshintrc
.npmignore
.travis.yml
.versions
LICENSE
README.md
bower.json
gulpfile.js expose bignumber.js
index.js changed project structure
karma.conf.js
package-init.js
package.js
package.json

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
Something went wrong with that request. Please try again.