You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Marek Kotewicz 24814a4f0f Merge branch 'master' of https://github.com/ethereum/ethereum.js 10 years ago
dist sha3 method signature 10 years ago
example fixed example 10 years ago
lib Merge branch 'master' of https://github.com/ethereum/ethereum.js 10 years ago
.bowerrc Converted to node module 10 years ago
.editorconfig Updated bower.json & Readme 10 years ago
.gitignore merged subprotocol prefix 10 years ago
.jshintrc Converted to node module 10 years ago
.npmignore Refactoring 10 years ago
.travis.yml Enable JSHint linting 10 years ago
LICENSE Converted to node module 10 years ago
README.md Update README.md 10 years ago
bower.json Changed npm & bower version 10 years ago
gulpfile.js gulpfile modifications, default build set to dev 10 years ago
index.js fixes for node.js 10 years ago
package.json version upgraded 10 years ago

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

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.

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

Building

gulp

Testing

mocha

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