Skip to content

javascript

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

javascript

README.md

aces_listener_api

AcesListenerApi - JavaScript client for aces_listener_api API Specification for ACES Listeners that read data on a blockchain and forward transaction events to registered subscribers. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install aces_listener_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AcesListenerApi = require('aces_listener_api');

var defaultClient = AcesListenerApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new AcesListenerApi.AcesListenerApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.statusGet(callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/v1

Class Method HTTP request Description
AcesListenerApi.AcesListenerApi statusGet GET /status Get Health of node.
AcesListenerApi.AcesListenerApi subscriptionsIdEventsGet GET /subscriptions/{id}/events List Subscription Events
AcesListenerApi.AcesListenerApi subscriptionsIdGet GET /subscriptions/{id} Gets Subscription
AcesListenerApi.AcesListenerApi subscriptionsIdUnsubscribesPost POST /subscriptions/{id}/unsubscribes Create an Unsubscription.
AcesListenerApi.AcesListenerApi subscriptionsPost POST /subscriptions Registers a subscriber node to receive blockchain events.

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication