enujs-api
v7.0.4
Published
Application programming interface to Enumivo blockchain nodes.
Downloads
18
Readme
Enu API
Application programming interface to Enumivo blockchain nodes. This is for read-only API calls. If you need to sign transactions use enujs instead.
Include
- Install with:
npm install enujs-api - Html script tag, see releases for the correct version and its matching script integrity hash.
<html>
<head>
<meta charset="utf-8">
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/enu-api.min.js"
crossorigin="anonymous"></script>
</head>
<body>
See console object: EnuApi
</body>
</html>EnuApi
Run enunode
Usage
EnuApi = require('enujs-api') // Or EnuApi = require('./src')
enu = EnuApi() // // 127.0.0.1:8888
// 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 enujs/json/api/v1..
enu.getInfo()
// A Promise is returned if a callback is not provided.
enu.getInfo({}).then(result => console.log(result))
enu.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
enu.getInfo(callback)
// Parameters are added before the callback
enu.getBlock(1, callback)
// Parameters can be an object
enu.getBlock({block_num_or_id: 1}, callback)
enu.getBlock({block_num_or_id: 1}).then(result => console.log(result))Configuration
EnuApi = require('enujs-api') // Or EnuApi = require('./src')
// everything is optional
options = {
httpEndpoint: 'http://127.0.0.1:8888', // default, null for cold-storage
verbose: false, // API logging
logger: { // Default logging functions
log: config.verbose ? console.log : null,
error: config.verbose ? console.error : null
},
fetchConfiguration: {}
}
enu = EnuApi(options)options.logger example
During testing, an error may be expected and checked as follows:
options.logger = {
error: err => {
assert.equal(err, 'expected error')
done()
}
}options.fetchConfiguration example
options.fetchConfiguration = {
credentials: 'same-origin'
}Every enujs-api request will run fetch with this configuration:
fetch('https://example.com', {
credentials: 'same-origin'
})Environment
Node and browser (es2015)