mirror of https://github.com/status-im/web3.js.git
fb74d60d20 | ||
---|---|---|
docs | ||
examples | ||
packages | ||
src | ||
test | ||
.bowerrc | ||
.editorconfig | ||
.gitignore | ||
.jshintignore | ||
.jshintrc | ||
.npmignore | ||
.travis.yml | ||
.versions | ||
LICENSE | ||
README.md | ||
bower.json | ||
circle.yml | ||
gulpfile.js | ||
lerna.json | ||
package-init.js | ||
package.js | ||
package.json | ||
styleguide.md |
README.md
web3.js has moved from 0.x.x to 1.x.x. This is a majore refactor, please read the following guide to update your dapp.
web3.js - 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 Ethereum node to use this library.
Installation
Node.js
npm install web3
Meteor.js
meteor add ethereum:web3
As Browser module
Bower
bower install web3
Component
component install ethereum/web3.js
- Include
web3.min.js
in your html file. (not required for the meteor package)
Usage
Use the web3
object directly from global namespace:
console.log(web3); // {eth: .., shh: ...} // it's here!
Set a provider (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);
You can find more examples in example
directory.
Documentation
Documentation can be found at read the docs
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