Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 1.89 KB

README.md

File metadata and controls

80 lines (63 loc) · 1.89 KB

viz.js

viz.js the JavaScript Library with API Support for VIZ blockchain

npm version

Documentation

Here is full documentation: https://github.com/VIZ-Blockchain/viz-js-lib/tree/master/doc

Install

$ npm install viz-js-lib --save

Browser

Online library minify js available in jsDelivr CND and Unpkg CDN.

<script src="./viz.min.js"></script>
<script>
viz.api.getAccounts(['ned', 'dan'], function(err, response){
    console.log(err, response);
});
</script>

Build

apt-get install -y webpack
apt-get install -y npm
apt-get install -y git

npm install -g n
n v8.4.0
PATH="$PATH"

git clone https://github.com/VIZ-Blockchain/viz-js-lib.git
cd viz-js-lib/

npm install
npm run build-browser
ls dist

Server

WebSockets and HTTP transport

Library support 2 transport types: ws, wss for websocket and http, https for pure HTTP JSONRPC. Examples:

viz.config.set('websocket','wss://viz.lexai.host/');
viz.config.set('websocket','https://rpc.viz.lexai.host/');

Examples

Broadcast Vote

var viz = require('viz-js-lib');//nodejs lib

var wif = viz.auth.toWif(username, password, 'regular');
viz.broadcast.vote(wif, voter, author, permlink, weight, function(err, result) {
	console.log(err, result);
});

Get Accounts

viz.api.getAccounts(['ned', 'dan'], function(err, result) {
	console.log(err, result);
});

Contributions

Patches are welcome! Contributors are listed in the package.json file. Please run the tests before opening a pull request and make sure that you are passing all of them. If you would like to contribute, but don't know what to work on, check the issues list.

Issues

When you find issues, please report them!

License

MIT