https://github.com/howardwu/blocktrail-unofficial
A Blocktrail adapter built to standardize the output of requests to follow the common-blockchain convention
https://github.com/howardwu/blocktrail-unofficial
Last synced: 18 days ago
JSON representation
A Blocktrail adapter built to standardize the output of requests to follow the common-blockchain convention
- Host: GitHub
- URL: https://github.com/howardwu/blocktrail-unofficial
- Owner: howardwu
- Created: 2015-06-29T21:01:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-08-10T17:25:09.000Z (over 9 years ago)
- Last Synced: 2025-03-15T01:03:16.723Z (about 1 month ago)
- Language: JavaScript
- Size: 13.2 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# blocktrail-unofficial
A Blocktrail adapter built to standardize the output of requests to follow the common-blockchain convention
[](https://www.npmjs.org/package/blocktrail-unofficial)
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](https://github.com/common-blockchain/common-blockchain/blob/master/README.md)
## 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.
```javascript
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](https://github.com/blockai/abstract-common-blockchain/blob/master/README.md) 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](https://github.com/blockai/abstract-common-blockchain/blob/master/README.md)
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](https://www.blocktrail.com/api/docs#rate_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
* Howard Wu (howardwu) - [email protected]
* Andrew Malta (andrewmalta13) - [email protected]