status-im
/
web3.js
mirror of https://github.com/status-im/web3.js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Ethereum JavaScript API
1,353 Commits 27 Branches 52 Tags 24 MiB
JavaScript 94.5%
HTML 5.5%
Go to file
Andrea Maria Piana e9330e5dfb
Add public chat filter 		2018-12-29 09:40:52 +01:00
dist Add public chat filter 2018-12-29 09:40:52 +01:00
example Example Code for Message Signing Added (#968) 2017-08-02 15:12:23 +02:00
lib Add public chat filter 2018-12-29 09:40:52 +01:00
test Add shhext_post method 2018-04-23 12:57:40 +03:00
.bowerrc fixed #149 2015-03-30 09:11:56 +02:00
.editorconfig Updated bower.json & Readme 2014-11-05 22:33:28 +02:00
.gitignore ignore packages folder for now 2017-06-24 10:24:16 +02:00
.jshintrc fixed lint 2017-05-09 12:08:09 +02:00
.npmignore Refactoring 2014-11-06 22:51:37 +02:00
.travis.yml bump node versions for travis 2015-10-06 01:00:06 +02:00
.versions bumped version 0.20.1 2017-07-17 13:35:23 +02:00
LICENSE update license per name change to web3.js 2015-06-10 10:04:05 -07:00
README.md add yarn to readme (#976) 2017-08-10 14:08:55 +02:00
bower.json bumped to version alpha 2016-05-30 10:50:13 +02:00
circle.yml CI - add circleCI config 2016-08-26 16:16:59 -07:00
gulpfile.js fixed #318, upgraded del package to 2.0.2 2015-10-05 09:25:25 +02:00
index.js add currentProvider back and fixed index.js 2015-10-08 11:20:45 +02:00
package-init.js add currentProvider back and fixed index.js 2015-10-08 11:20:45 +02:00
package.js bumped version 0.20.1 2017-07-17 13:35:23 +02:00
package.json Add join/leave methods 2018-12-28 13:47:23 +01:00
styleguide.md use 4 spaces instead of 2 2015-07-16 13:42:30 +02:00

README.md

Migration 0.13.0 -> 0.14.0

web3.js version 0.14.0 supports multiple instances of web3 object. To migrate to this version, please follow the guide:

-var web3 = require('web3');
+var Web3 = require('web3');
+var web3 = new Web3();

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 status Coverage Status Stories in Ready

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

Documentation

Installation

Node.js

npm install web3

Yarn

yarn add 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)

if (typeof web3 !== 'undefined') {
  web3 = new Web3(web3.currentProvider);
} else {
  // set the provider you want from Web3.providers
  web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"));
}

Set a provider (HttpProvider using HTTP Basic Authentication)

web3.setProvider(new web3.providers.HttpProvider('http://host.url', 0, BasicAuthUsername, BasicAuthPassword));

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

Community

Other implementations