jsgoat

goatjs

Install

Require style

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

const goatjs = require('goatjs')

CDN style

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

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

By default, goatjs hits on the main stc testnet (https://api.staketoclaim.com). You can eventually make goatjs hit on your local node or any stc node like so:

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

GET API

GET single account

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

GET many accounts

Just pass an array of usernames instead

goatjs.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

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

GET single content

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

GET followers

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

GET following

goatjs.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'.

goatjs.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'.

goatjs.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'.

goatjs.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'.

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

GET notifications

goatjs.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: goatjs.TransactionType.FOLLOW,
    data: {
        target: 'bob'
    }
}

newTx = goatjs.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

goatjs.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:

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

Convenience

Generate a keypair

console.log(goatjs.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()

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