node package manager

blocktrail-unofficial

blocktrail-unofficial

A Blocktrail adapter built to standardize the output of requests to follow the common-blockchain convention

Version

A Blocktrail adapter built to standardize the output of requests to follow the common-blockchain convention. Aliases are introduced in the return of functions to account for differences in convention between the two standards. It is our hope that the Bitcoin community will come to an agreement on proper style and convention for requests on addresses, transactions, and blocks.

Information on common-blockchain for convention

Installation

Install as you normally install an npm module:

  npm install blocktrail-unofficial

Usage

Run npm install to have all necessary node modules installed.

Export a Blocktrail APIKEY and APISECRET by creating an API Key from your account on Blocktrail.

To use the blocktrail API, simply require the module.

  var blocktrailAPI = require('blocktrail-unofficial');
  var commonBlockchain = blocktrailAPI({ 
    network: 'mainnet',
    apiKey: process.env.APIKEY,
    apiSecret: process.env.APISECRET
  });

For Mainnet, use blocktrailAPI({ network: 'mainnet' }) when calling a function. For Testnet, use blocktrailAPI({ network: 'testnet' }) when calling a function. By default, if no parameter is provided, Mainnet will be used.

Tests

Run npm test to have abstract-common-blockchain run a suite of tests on Addresses, Blocks, and Transactions. The tests are comprehensive with complete code coverage - see documentation in abstract-common-blockchain for further details.

API Examples

See abstract-common-blockchain for API

There are examples for using Addresses, Blocks, and Transactions, provided in the /examples folder. Each function includes a Mainnet and Testnet sample call and where possible, an invalid example is provided to show error handling. Expect all returns to be of the form (error, response).

Request Limits

Blocktrail has a request limit of 86,400 API requests per 24 hours, at a rate of 1 request per second. Burst capabilities are available at 2 requests per second at ten minute intervals. Therefore, large arrays of inputs to blocktrail-unofficial may result in errors or long wait times for responses due to the constricted nature of Blocktrail's request limit.

Information on Blocktrail's Request Limits

Convention

Standard convention is described fully by common-blockchain in the types.json file: https://github.com/blockai/common-blockchain/blob/master/types.json

Maintainers