https://github.com/howardwu/biteasy-unofficial
Biteasy adapter built to standardize requests to the common-blockchain convention
https://github.com/howardwu/biteasy-unofficial
Last synced: 24 days ago
JSON representation
Biteasy adapter built to standardize requests to the common-blockchain convention
- Host: GitHub
- URL: https://github.com/howardwu/biteasy-unofficial
- Owner: howardwu
- Created: 2015-06-26T05:40:30.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-08-10T17:50:05.000Z (over 9 years ago)
- Last Synced: 2024-04-28T13:22:17.100Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 1 MB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# biteasy-unofficial
[](https://www.npmjs.org/package/biteasy-unofficial)
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](https://github.com/common-blockchain/common-blockchain/blob/master/README.md)
## 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.
```javascript
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](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
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](http://support.biteasy.com/kb/rest-api/rate-limiting)
## 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]