status-im
/
web3.js
mirror of https://github.com/status-im/web3.js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Ethereum JavaScript API
324 Commits 27 Branches 52 Tags 24 MiB
JavaScript 94.5%
HTML 5.5%
Go to file
Marek Kotewicz b41d7b3134 Merge branch 'master' into develop 2015-02-23 15:44:28 +01:00
dist Made to/fromWei return strings instead of numbers 2015-02-20 12:40:09 +01:00
example changed most of the function names 2015-02-19 18:37:09 +01:00
lib Made to/fromWei return strings instead of numbers 2015-02-20 12:40:09 +01:00
test fixed tests 2015-02-23 10:01:00 +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 travis coveralls 2015-02-17 08:59:19 +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 travis coveralls 2015-02-16 22:53:04 +01:00
LICENSE Converted to node module 2014-11-05 19:46:01 +02:00
README.md Merge branch 'master' into develop 2015-02-23 15:44:28 +01:00
bower.json Made to/fromWei return strings instead of numbers 2015-02-20 12:40:09 +01:00
gulpfile.js gulp cleanup 2015-02-17 12:11:57 +01:00
index.js providermanager -> requestmanager 2015-02-06 00:02:14 +01:00
package.json Made to/fromWei return strings instead of numbers 2015-02-20 12:40:09 +01:00

README.md

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

NPM version Build Status dependency status dev dependency statusCoverage 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 bignumber.js

Usage

Require the library:

var web3 = require('web3');

Set a provider (QtSyncProvider, HttpSyncProvider)

web3.setProvider(new web3.providers.HttpSyncProvider());

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