@hiveio/hive-js

Hive.js

Hive.js the Official JavaScript API for Hive blockchain

Documentation

• Install
• Browser
• Config
• Database API
  • Subscriptions
  • Tags
  • Blocks and transactions
  • Globals
  • Keys
  • Accounts
  • Market
  • Authority / validation
  • Votes
  • Content
  • Witnesses
• Login API
• Follow API
• Broadcast API
• Broadcast
• Auth
• Formatter
• Utils
• Tutorials

Here is full documentation: https://gitlab.syncad.com/hive/hive-js/tree/master/doc

Browser

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

CDN

https://cdn.jsdelivr.net/npm/@hiveio/hive-js/dist/hive.min.js

<script src="https://cdn.jsdelivr.net/npm/@hiveio/hive-js/dist/hive.min.js"></script>

Webpack

Please have a look at the webpack usage example.

Server

Install

$ npm install @hiveio/hive-js --save

RPC Servers

https://api.hive.blog By Default
https://anyx.io
https://api.openhive.network
https://api.hivekings.com
https://api.pharesim.me
https://hived.privex.io
https://rpc.ausbit.dev
https://rpc.esteem.app
_{List of Hive nodes}

Examples

Broadcast Vote

var hive = require('@hiveio/hive-js');

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

Get Accounts

hive.api.getAccounts(['mahdiyari', 'hiveio'], function(err, result) {
	console.log(err, result);
});

Get State

hive.api.getState('/trends/funny', function(err, result) {
	console.log(err, result);
});

Reputation Formatter

var reputation = hive.formatter.reputation(user.reputation);
console.log(reputation);

Hive Testnet

Hive-js requires some configuration to work on the public Hive testnet.

You need to set two Hive API options, address_prefix and chain_id.

hive.api.setOptions({
  address_prefix: 'TST',
  chain_id: '46d82ab7d8db682eb1959aed0ada039a6d49afa1602491f93dde9cac3e8e6c32',
  useTestNet: true,
});

The Chain ID could change. If it does, it may not be reflected here, but will be documented on any testnet launch announcements.

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.

Issues

When you find issues, please report them!

License

MIT