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.
 
 
 
 
 
Marek Kotewicz 6a74306109 merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
..
dist merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
example merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
lib merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
test merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 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 'be3bfb76bef1d1f113033cd9093e03a00066d5d1' into ethereumjs_timeout 10 years ago
.npmignore Merge commit '3871bac1d0ac3b0e7f8490fba646f159fa65d8b5' as 'libjsqrc/ethereumjs' 10 years ago
.travis.yml Merge commit '99f713fa869f41401e9383f2626ed46d3821cc29' into develop 10 years ago
.versions Merge commit '3cf8dcb19983b41a387065746e6d3ce08ef7ef4c' into new_jsonrpc 10 years ago
LICENSE Merge commit '3871bac1d0ac3b0e7f8490fba646f159fa65d8b5' as 'libjsqrc/ethereumjs' 10 years ago
README.md Merge commit '99f713fa869f41401e9383f2626ed46d3821cc29' into develop 10 years ago
bower.json merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
gulpfile.js manual merge of ethereum.js 10 years ago
index.js merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
karma.conf.js manual merge of ethereum.js 10 years ago
package-init.js Merge commit '99f713fa869f41401e9383f2626ed46d3821cc29' into develop 10 years ago
package.js merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 10 years ago
package.json merge commit '89dbcca30b752ecf2b8b56b5f396a6a86c29fc0a' into web.js4.2 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)
  • Include bignumber.js (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 (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