❤
npm
Sign UpSign In

alaxplorerjs-api

7.0.0 • Public • Published

NPM

Ala API

Application programming interface to ALA blockchain nodes. This is for read-only API calls. If you need to sign transactions use alaxplorerjs instead.

Include

  • Install with: npm install alaxplorerjs-api
  • Html script tag, see releases for the correct version and its matching script integrity hash.
<html>
<head>
  <meta charset="utf-8">
  <!--
  sha512-QhGZxYAobgbwwfLU/XJJGXnZIlryDmb+1UZhA7tXpQagDUMfQ5UpriwIVk8B3GpgU178MoEGZJXwDUWQtCkfUg== lib/ala-api.js
  sha512-1vZNvckFHfp7QPyWbFt/Jqr0jKiQeBsS+7O1/KGmXD7Fpzv+cW6Cm4w7m9uN4pGBwJEAzkxPVzzZ0Q2QV5jN0g== lib/ala-api.min.js
  sha512-55C/rD7i39x8mQHcKGaLYiRnAtZ5sldYMvvwGMHU+9RaLxT5FlhjpqgoubVWGHwPJM/9qVISF82ryYnlFxkwWQ== lib/ala-api.min.js.map
  -->
  <script src="https://cdn.jsdelivr.net/npm/alaxplorerjs-api@7.0.0/lib/ala-api.min.js"
    integrity="sha512-1vZNvckFHfp7QPyWbFt/Jqr0jKiQeBsS+7O1/KGmXD7Fpzv+cW6Cm4w7m9uN4pGBwJEAzkxPVzzZ0Q2QV5jN0g=="
    crossorigin="anonymous"></script> 
 
</head>
<body>
  See console object: AlaApi
</body>
</html>

AlaApi

Run alanode

Usage

AlaApi = require('alaxplorerjs-api') // Or AlaApi = require('./src')
 
ala = AlaApi() // // 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 alaxplorerjs/json/api/v1..
ala.getInfo()
 
// A Promise is returned if a callback is not provided.
ala.getInfo({}).then(result => console.log(result))
ala.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
ala.getInfo(callback)
 
// Parameters are added before the callback
ala.getBlock(1, callback)
 
// Parameters can be an object
ala.getBlock({block_num_or_id: 1}, callback)
ala.getBlock({block_num_or_id: 1}).then(result => console.log(result))

Configuration

AlaApi = require('alaxplorerjs-api') // Or AlaApi = 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 : '',
    error: console.error
  },
  fetchConfiguration: {}
}
 
ala = AlaApi(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 alaxplorerjs-api request will run fetch with this configuration:

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

API Documentation

API methods and documentation are generated from:

Helper functions:

Environment

Node and browser (es2015)

Readme

Keywords

Package Sidebar

Install

npm i alaxplorerjs-api

Repository

github.com/ALAIO/alaxplorerjs-api

Homepage

github.com/ALAIO/alaxplorerjs-api#readme

Weekly Downloads

4

Version

7.0.0

License

MIT

Unpacked Size

36.1 kB

Total Files

15

Last publish

Collaborators

  • aladinnetwork
Try on RunKit
Report malware