mirror of https://github.com/status-im/web3.js.git
75e92c8048 | ||
---|---|---|
dist | ||
example | ||
lib | ||
test | ||
.bowerrc | ||
.editorconfig | ||
.gitignore | ||
.jshintrc | ||
.npmignore | ||
.travis.yml | ||
LICENSE | ||
README.md | ||
bower.json | ||
gulpfile.js | ||
index.js | ||
karma.conf.js | ||
package.json |
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
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
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