Home

Awesome

biteasy-unofficial

Version

A Biteasy 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 biteasy-unofficial

Usage

Run npm install to have all necessary node modules installed.

To use the Biteasy API, simply require the module.

  var biteasyAPI = require('biteasy-unofficial');
  var commonBlockchain = biteasyAPI({ network: 'mainnet' });

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

Known Issues

Biteasy currently only returns the confirmed balance of an address when requested. Therefore, our parameters for balance, confirmedBalance, and unconfirmedBalance are specified as such:

  {
    balance: null,
    confirmedBalance: 0.0,
    unconfirmedBalance: null
  }

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

Biteasy has a request limit of 4 requests per second and 345600 requests per day per IP. Therefore, large arrays of inputs to biteasy-unofficial may result in errors or long wait times for responses due to the constricted nature of Biteasy's request limit.

Information on Biteasy 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