2014-09-30 23:55:07 +03:00
# Ethereum JavaScript API
2014-10-21 01:41:27 +03:00
This is the Ethereum compatible JavaScript API using `Promise` s
2014-11-05 19:46:01 +02:00
which implements the [Generic JSON RPC ](https://github.com/ethereum/wiki/wiki/Generic-JSON-RPC ) spec. It's available on npm as a node module and also for bower and component as an embeddable js
2014-09-30 23:55:07 +03:00
2014-11-09 21:30:27 +02:00
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url] [![dev dependency status][dep-dev-image]][dep-dev-url]
2014-11-05 22:33:28 +02:00
2014-11-10 15:26:10 +02:00
<!-- [![browser support ](https://ci.testling.com/ethereum/ethereum.js.png )](https://ci.testling.com/ethereum/ethereum.js) -->
2014-11-05 22:33:28 +02:00
2014-11-06 22:51:37 +02:00
## Installation
2014-11-05 19:46:01 +02:00
2014-11-06 22:51:37 +02:00
### Node.js
2014-11-05 19:46:01 +02:00
npm install ethereum.js
2014-11-06 22:51:37 +02:00
### For browser
2014-11-05 19:46:01 +02:00
Bower
bower install ethereum.js
Component
component install ethereum/ethereum.js
* Include `ethereum.min.js` in your html file.
* Include [es6-promise ](https://github.com/jakearchibald/es6-promise ) or another ES6-Shim if your browser doesn't support ECMAScript 6.
2014-11-06 22:51:37 +02:00
## Usage
2014-11-05 19:46:01 +02:00
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` .
2015-01-11 18:54:36 +02:00
## Contribute!
### Requirements
* Node.js
* npm
* gulp (build)
* mocha (tests)
```bash
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
sudo apt-get install nodejs-legacy
```
2015-01-15 15:30:34 +02:00
### Building (gulp)
2014-11-05 19:46:01 +02:00
2015-01-15 15:30:34 +02:00
```bash
2015-01-11 18:54:36 +02:00
npm run-script build
```
2014-11-05 19:46:01 +02:00
2015-01-15 15:30:34 +02:00
### Testing (mocha)
2014-09-30 23:55:07 +03:00
2015-01-15 15:30:34 +02:00
```bash
2015-01-11 18:54:36 +02:00
npm test
```
2014-09-30 23:55:07 +03:00
**Please note this repo is in it's early stage.**
2014-09-30 23:58:09 +03:00
If you'd like to run a WebSocket ethereum node check out
[go-ethereum ](https://github.com/ethereum/go-ethereum ).
To install ethereum and spawn a node:
```
go get github.com/ethereum/go-ethereum/ethereum
ethereum -ws -loglevel=4
```
2014-11-05 22:33:28 +02:00
2014-11-09 21:30:27 +02:00
[npm-image]: https://badge.fury.io/js/ethereum.js.png
[npm-url]: https://npmjs.org/package/ethereum.js
2014-11-10 14:31:51 +02:00
[travis-image]: https://travis-ci.org/ethereum/ethereum.js.svg
[travis-url]: https://travis-ci.org/ethereum/ethereum.js
[dep-image]: https://david-dm.org/ethereum/ethereum.js.svg
[dep-url]: https://david-dm.org/ethereum/ethereum.js
[dep-dev-image]: https://david-dm.org/ethereum/ethereum.js/dev-status.svg
2015-01-11 18:54:36 +02:00
[dep-dev-url]: https://david-dm.org/ethereum/ethereum.js#info=devDependencies