2.6 KiB

Raw Blame History

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 and also for bower and component as an embeddable js

Documentation

Installation

Node.js

$ npm install ethereum.js

Meteor.js

$ meteor add ethereum:js

For browser

Bower

$ bower install ethereum.js

Component

$ component install ethereum/ethereum.js

Include ethereum.min.js in your html file.
Include bignumber.js

Usage

Require the library:

var web3 = require('web3');

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
gulp (build)
mocha (tests)

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

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

2.6 KiB Raw Blame History