Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiseplat/npm2-web3.js
Wiseplat JavaScript API, middleware to talk to a wiseplat node over RPC
https://github.com/wiseplat/npm2-web3.js
Last synced: about 6 hours ago
JSON representation
Wiseplat JavaScript API, middleware to talk to a wiseplat node over RPC
- Host: GitHub
- URL: https://github.com/wiseplat/npm2-web3.js
- Owner: WISEPLAT
- License: other
- Created: 2018-04-24T09:39:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-24T10:00:54.000Z (over 6 years ago)
- Last Synced: 2024-10-30T16:20:49.685Z (16 days ago)
- Language: JavaScript
- Size: 742 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Migration 0.13.0 -> 0.14.0
web3.js version 0.14.0 supports [multiple instances of web3](https://github.com/wiseplat/npm2-web3.js/issues/297) object.
To migrate to this version, please follow the guide:
```diff
-var web3 = require('npm2-web3');
+var Web3 = require('npm2-web3');
+var web3 = new Web3();
```
# Wiseplat JavaScript API
[](https://gitter.im/wiseplat/web3.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
This is the Wiseplat compatible [JavaScript API](https://github.com/wiseplat/wiki/wiki/JavaScript-API)
which implements the [Generic JSON RPC](https://github.com/wiseplat/wiki/wiki/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][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 Wiseplat node to use this library.
[Documentation](https://github.com/wiseplat/wiki/wiki/JavaScript-API)
## Installation
### Node.js
```bash
npm install npm2-web3
```
### Meteor.js
```bash
meteor add wiseplat:web3
```
### As Browser module
Bower
```bash
bower install npm2-web3
```
Component
```bash
component install wiseplat/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:
```js
console.log(web3); // {wsh: .., shh: ...} // it's here!
```
Set a provider (HttpProvider)
```js
web3.setProvider(new web3.providers.HttpProvider('http://localhost:8747'));
```
There you go, now you can use it:
```js
var coinbase = web3.wsh.coinbase;
var balance = web3.wsh.getBalance(coinbase);
```
You can find more examples in [`example`](https://github.com/wiseplat/npm2-web3.js/tree/master/example) directory.
## Contribute!
### Requirements
* Node.js
* npm
```bash
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
sudo apt-get install nodejs-legacy
```
### Building (gulp)
```bash
npm run-script build
```
### Testing (mocha)
```bash
npm test
```
[npm-image]: https://badge.fury.io/js/web3.png
[npm-url]: https://npmjs.org/package/web3
[travis-image]: https://travis-ci.org/wiseplat/web3.js.svg
[travis-url]: https://travis-ci.org/wiseplat/web3.js
[dep-image]: https://david-dm.org/wiseplat/web3.js.svg
[dep-url]: https://david-dm.org/wiseplat/web3.js
[dep-dev-image]: https://david-dm.org/wiseplat/web3.js/dev-status.svg
[dep-dev-url]: https://david-dm.org/wiseplat/web3.js#info=devDependencies
[coveralls-image]: https://coveralls.io/repos/wiseplat/web3.js/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/r/wiseplat/web3.js?branch=master
[waffle-image]: https://badge.waffle.io/wiseplat/web3.js.svg?label=ready&title=Ready
[waffle-url]: http://waffle.io/wiseplat/web3.js