Go to file
Marek Kotewicz c34b0c67a1 Update README.md 2015-01-11 16:23:06 +01:00
dist missing jshint ignore 2015-01-08 15:43:22 +01:00
example fixed example 2015-01-08 15:31:46 +01:00
lib module var fix 2015-01-09 12:44:11 +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 merged subprotocol prefix 2014-11-11 10:30:21 +01:00
.jshintrc Converted to node module 2014-11-05 19:46:01 +02:00
.npmignore Refactoring 2014-11-06 22:51:37 +02:00
.travis.yml Enable JSHint linting 2014-11-14 14:00:19 -05:00
LICENSE Converted to node module 2014-11-05 19:46:01 +02:00
README.md Update README.md 2015-01-11 16:23:06 +01:00
bower.json Changed npm & bower version 2014-11-10 15:26:10 +02:00
gulpfile.js gulpfile modifications, default build set to dev 2015-01-07 14:13:29 +01:00
index.js fixes for node.js 2015-01-08 15:11:20 +01:00
package.json version upgrade 2015-01-08 15:13:43 +01:00

README.md

Ethereum JavaScript API

This is the Ethereum compatible JavaScript API using Promises 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 status

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
sudo npm install -g gulp
sudo npm install -g mocha

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 es6-promise or another ES6-Shim if your browser doesn't support ECMAScript 6.

Usage

Require the library:

var web3 = require('web3');

Set a provider (QtProvider, WebSocketProvider, HttpRpcProvider)

var web3.setProvider(new web3.providers.WebSocketProvider('ws://localhost:40404/eth'));

There you go, now you can use it:

web3.eth.coinbase.then(function(result){
  console.log(result);
  return web3.eth.balanceAt(result);
}).then(function(balance){
  console.log(web3.toDecimal(balance));
}).catch(function(err){
  console.log(err);
});

For another example see example/index.html.

Building

  • gulp build

Testing

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