README

jsgoat

Install

Require style

Install with npm install --save jsgoat inside your project. Then just

const jsgoat = require('jsgoat')

CDN style

If you are working in the browser and want to load jsgoat from a CDN:

<script src="https://unpkg.com/jsgoat/bin/jsgoat.min.js"></script>

By default, jsgoat hits on the main goat testnet (https://api.goat.games). You can eventually make jsgoat hit on your local node or any goatchain node like so:

jsgoat.init({api: 'http://localhost:3001'})

GET API

GET single account

jsgoat.getAccount('alice', (err, account) => {
    console.log(err, account)
})

GET many accounts

Just pass an array of usernames instead

jsgoat.getAccounts(['alice', 'bob'], (err, accounts) => {
    console.log(err, accounts)
})

GET account transaction history

For the history, you also need to specify a block number. The api will return all blocks lower than the specified block where the user was involved in a transaction

jsgoat.getAccountHistory('alice', 0, (err, blocks) => {
    console.log(err, blocks)
})

GET single content

jsgoat.getContent('alice', 'pocNl2YhZdM', (err, content) => {
    console.log(err, content)
})

GET followers

jsgoat.getFollowers('alice', (err, followers) => {
    console.log(err, followers)
})

GET following

jsgoat.getFollowers('alice', (err, followers) => {
    console.log(err, followers)
})

GET contents by author

You can pass a username and permlink (identifying a content) in the 2nd and 3rd argument to 'get more'.

jsgoat.getDiscussionsByAuthor('alice', null, null, (err, contents) => {
    console.log(err, contents)
})

GET contents by creation time

You can pass a username and a permlink to 'get more'.

jsgoat.getNewDiscussions('alice', null, null, (err, contents) => {
    console.log(err, contents)
})

GET contents by popularity (hot)

You can pass a username and a permlink to 'get more'.

jsgoat.getHotDiscussions(null, null, (err, contents) => {
    console.log(err, contents)
})

GET contents by feed

This lists the contents posted by the following of the passed username.

You can pass a username and a permlink in the 2nd and 3rd argument to 'get more'.

jsgoat.getFeedDiscussions('alice', null, null, (err, contents) => {
    console.log(err, contents)
})

GET notifications

jsgoat.getNotifications('alice', (err, contents) => {
    console.log(err, contents)
})

POST API

To send a transaction to the network, you will need multiple steps. First you need to define your transaction and sign it.

var newTx = {
    type: jsgoat.TransactionType.FOLLOW,
    data: {
        target: 'bob'
    }
}

newTx = jsgoat.sign(alice_key, 'alice', newTx)

After this step, the transaction is forged with a timestamp, hash, and signature. This transaction needs to be sent in the next 60 secs or will be forever invalid.

You can send it like so

jsgoat.sendTransaction(newTx, function(err, res) {
    cb(err, res)
})

The callback will return once your transaction has been included in a new block.

Alternatively, you can just want the callback as soon as the receiving node has it, you can do:

jsgoat.sendRawTransaction(newTx, function(err, res) {
    cb(err, res)
})

Convenience

Generate a keypair

console.log(jsgoat.keypair())

Growing variables

Voting Power and Bandwidth are growing in time but the API will only return the latest update in the vt and bw fields of the accounts. To get the actual value, use votingPower() and bandwidth()

jsgoat.getAccount('alice', (err, account) => {
    console.log(jsgoat.votingPower(account))
    console.log(jsgoat.bandwidth(account)) 
})

Usage no npm install needed!