You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Gav Wood
2121dd1e27
|
10 years ago | |
---|---|---|
.. | ||
dist | 10 years ago | |
example | 10 years ago | |
lib | 10 years ago | |
test | 10 years ago | |
.bowerrc | 10 years ago | |
.editorconfig | 10 years ago | |
.gitignore | 10 years ago | |
.jshintrc | 10 years ago | |
.npmignore | 10 years ago | |
.travis.yml | 10 years ago | |
.versions | 10 years ago | |
LICENSE | 10 years ago | |
README.md | 10 years ago | |
bower.json | 10 years ago | |
gulpfile.js | 10 years ago | |
index.js | 10 years ago | |
karma.conf.js | 10 years ago | |
package-init.js | 10 years ago | |
package.js | 10 years ago | |
package.json | 10 years ago | |
version.json | 10 years ago |
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, 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.
Installation
Node.js
$ npm install ethereum.js
Meteor.js
$ meteor add ethereum:js
As Browser module
Bower
$ bower install ethereum.js
Component
$ component install ethereum/ethereum.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
Require the library (not required for the meteor package):
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
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