@snaxfoundation/snaxjs-api
v7.0.4
Published
Application programming interface to SNAX blockchain nodes.
Downloads
1
Readme
Snax API
Application programming interface to SNAX blockchain nodes. This is for read-only API calls. If you need to sign transactions use snaxjs instead.
Include
- Install with:
npm install snaxjs-api - Html script tag, see releases for the correct version and its matching script integrity hash.
<html>
<head>
<meta charset="utf-8">
<!--
sha512-n3CgU6w9TJVf/pVIMHYhk3Gxv8lEQYjVrSSTLXvEBENLF+CQd1Kp0jxXj09yGUOkWerdv2mJlh1Mnz3aRfYqWw== lib/snax-api.js
sha512-Cj2FQb94MMtDPgHb1R1577pEMjYhc+P5pNgv1/QwoJD9ntuR9rnWlqJACS/xNniNK5cFS6Y6CpQlHWpzWUeEbw== lib/snax-api.min.js
sha512-4C6oDKarS8DaXO99o342USbeQwqW98qik+QSzVGfof939gUpIyRDCnbGIGQAIkLNpYZIV4XanmRy3wcis6UW8w== lib/snax-api.min.js.map
-->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/snax-api.min.js"
integrity="sha512-LLDsX/GdVZYA82k9TVz3zUxSjvaX8s5b1FJm64W51JGxLFKI2z+ljqYQtsUZIOxh9pSUqvLA5HCoxXqdRxusKw=="
crossorigin="anonymous"></script>
</head>
<body>
See console object: SnaxApi
</body>
</html>SnaxApi
Run snaxnode
Usage
SnaxApi = require('snaxjs-api') // Or SnaxApi = require('./src')
snax = SnaxApi() // // 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 snaxjs/json/api/v1..
snax.getInfo()
// A Promise is returned if a callback is not provided.
snax.getInfo({}).then(result => console.log(result))
snax.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
snax.getInfo(callback)
// Parameters are added before the callback
snax.getBlock(1, callback)
// Parameters can be an object
snax.getBlock({block_num_or_id: 1}, callback)
snax.getBlock({block_num_or_id: 1}).then(result => console.log(result))Configuration
SnaxApi = require('snaxjs-api') // Or SnaxApi = 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: {}
}
snax = SnaxApi(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 snaxjs-api request will run fetch with this configuration:
fetch('https://example.com', {
credentials: 'same-origin'
})Environment
Node and browser (es2015)