ethminer/libjsqrc/ethereumjs

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.

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

Documentation

Installation

Node.js

$ npm install web3

Meteor.js

$ meteor add ethereum:js

As Browser module

Bower

$ bower install web3

Component

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

You can require the library (not required for the meteor package):

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

Or use it directly from global namespace:

console.log(web3); // {eth: .., shh: ...} // it's here!

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