eosjs-api

Eos API

Application programming interface to EOS blockchain nodes. This is mostly for read-only API calls. If you decide you need to sign transactions, your better off using this API in the eosjs package.

Requirements

api.Testnet()

Internet access

api.Localnet()

Build and run nodeos or direct requests to a public testnet or production node.

Usage

api = require('eosjs-api') // Or api = require('./src')

testnet = api.Testnet() // See ./src/testnet.js for configuration

// Any API call without a callback parameter will print documentation: description,
// parameters, return value, and possible errors.  All methods and documentation
// are created from JSON files in eosjs/json/api/v1..
testnet.getInfo()

// A Promise is returned if a callback is not provided.
testnet.getInfo({}).then(result => console.log(result))
testnet.getBlock(1).then(result => console.log(result))

// For callbacks instead of Promises provide a callback
callback = (err, res) => {err ? console.error(err) : console.log(res)}

// The server does not expect any parameters only the callback is needed
testnet.getInfo(callback)

// Parameters are added before the callback
testnet.getBlock(1, callback)

// Parameters can be an object
testnet.getBlock({block_num_or_id: 1}, callback)
testnet.getBlock({block_num_or_id: 1}).then(result => console.log(result))

Configuration

api = require('eosjs-api') // Or api = require('./src')

// everything is optional
options = {
  httpEndpoint: 'http://127.0.0.1:8888', // default
  debug: false, // API logging
  logger: { // Default logging functions
    log: console.log,
    error: console.error,
    debug: console.debug
  },
  fetchConfiguration: {}
}

testnet = api.Localnet(options)

options.logger example

During testing, an error may be expected and checked as follows:

options.logger = {
  error: err => {
    assert.equal(err, 'expected error')
  }
}

options.fetchConfiguration example

options.fetchConfiguration = {
  credentials: 'same-origin'
}

Every eosjs-api request will run fetch with this configuration:

fetch('https://example.com', {
  credentials: 'same-origin'
})

API Documentation

API methods and documentation are generated from:

• chain.json
• history.json

Helper functions:

• ./docs/index.md

Environment

Node and browser (es2015)