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.
 
 
 
 
 
debris 854270026d additional ssh methods 10 years ago
..
dist additional ssh methods 10 years ago
example updated web3 to version 0.9.0 10 years ago
lib additional ssh methods 10 years ago
test updated web3 to version 0.9.0 10 years ago
.bowerrc manual merge of ethereum.js 10 years ago
.editorconfig Merge commit '3871bac1d0ac3b0e7f8490fba646f159fa65d8b5' as 'libjsqrc/ethereumjs' 10 years ago
.gitignore manual merge of ethereum.js 10 years ago
.jshintrc Merge commit '8d6d0f84c18542369a0cdc8e9618c7e2fbf0bf6b' into web3_5.0 10 years ago
.npmignore Merge commit '3871bac1d0ac3b0e7f8490fba646f159fa65d8b5' as 'libjsqrc/ethereumjs' 10 years ago
.travis.yml Merge commit '1e652c0757b5440feb5ba32d46f8a887c32f57c2' into develop 10 years ago
.versions updated web3 to version 0.9.0 10 years ago
LICENSE Merge commit 'ae9fdda9ac2b451b8f4cc46828a2b9f4bed872c8' into web3.js.6.0 10 years ago
README.md updated web3 to version 0.9.0 10 years ago
bower.json updated web3 to version 0.9.0 10 years ago
gulpfile.js Merge commit '1e652c0757b5440feb5ba32d46f8a887c32f57c2' into develop 10 years ago
index.js updated web3 to version 0.9.0 10 years ago
package-init.js Merge commit '1e652c0757b5440feb5ba32d46f8a887c32f57c2' into develop 10 years ago
package.js updated web3 to version 0.9.0 10 years ago
package.json updated web3 to version 0.9.0 10 years ago
styleguide.md updated web3 to version 0.9.0 10 years ago

README.md

Ethereum JavaScript API

Join the chat at https://gitter.im/ethereum/web3.js

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.

NPM version Build Status dependency status dev dependency statusCoverage StatusStories in Ready

You need to run a local ethrereum node to use this library.

Documentation

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 ethereum.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.

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