Go to file
Marek Kotewicz 2ef5efc8f8 fixed #70, creating contract with nondefault constructor 2015-04-09 23:30:18 +02:00
dist fixed #70, creating contract with nondefault constructor 2015-04-09 23:30:18 +02:00
example fixed #149 2015-03-30 09:11:56 +02:00
lib fixed #70, creating contract with nondefault constructor 2015-04-09 23:30:18 +02:00
test fixed #70, creating contract with nondefault constructor 2015-04-09 23:30:18 +02:00
.bowerrc fixed #149 2015-03-30 09:11:56 +02:00
.editorconfig Updated bower.json & Readme 2014-11-05 22:33:28 +02:00
.gitignore fixed #149 2015-03-30 09:11:56 +02: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 let travis check if npm package is not broken 2015-03-31 11:03:14 +02: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 #140 badge 2015-03-30 14:52:14 +02:00
bower.json version 0.2.4 2015-04-02 16:31:05 +02:00
gulpfile.js version 0.2.0 2015-03-27 14:48:56 +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 version 0.2.4 2015-04-02 16:31:05 +02:00
package.json fixed spelling in package description 2015-04-02 19:37:13 +03:00

README.md

Ethereum JavaScript API

Join the chat at https://gitter.im/ethereum/ethereum.js

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 StatusStories in Ready

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