/web3.js

web3.js 0.20.6-maintenance for vnscoin

Primary LanguageJavaScriptOtherNOASSERTION

Vnscoin JavaScript API

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

This is the Vnscoin compatible JavaScript API which implements the Generic JSON RPC spec. It's available on npm as a node module, for Bower and component as embeddable scripts, and as a meteor.js package.

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url] [![dev dependency status][dep-dev-image]][dep-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Stories in Ready][waffle-image]][waffle-url]

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

Documentation

Table of Contents

Installation

Node.js

npm install vns-web3

Yarn

yarn add vns-web3

Usage

Use the web3 object directly from the global namespace:

console.log(web3); // {vns: .., 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:8585"));
}

Set a provider (HttpProvider using HTTP Basic Authentication):

web3.setProvider(new web3.providers.HttpProvider('http://' + BasicAuthUsername + ':' + BasicAuthPassword + '@localhost:8585'));

There you go, now you can use it:

var coinbase = web3.vns.coinbase;
var balance = web3.vns.getBalance(coinbase);

You can find more examples in the example directory.

Contribute!

Requirements

  • Node.js
  • npm
# On Linux:
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

License

LGPL-3.0+ © 2015 Contributors