RanchiMall/flosight-api
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme 6

Browse Source
This commit is contained in:
Manuel Araoz 2014-08-21 10:21:00 -04:00
parent 2e50e135a3
commit 67050ff3d1
1 changed files with 13 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -12,25 +12,6 @@ require certain information from the blockchain that bitcoind does not provide.
A blockchain explorer front-end has been developed on top of *Insight API*. It can A blockchain explorer front-end has been developed on top of *Insight API*. It can
be downloaded at [Github Insight Repository](https://github.com/bitpay/insight). be downloaded at [Github Insight Repository](https://github.com/bitpay/insight).
## IMPORTANT: Upgrading from v0.1 to v0.2
In order to optimize some queries, the key-value layout in Level DB has been changed.
If you are running v0.1.x, a total resync needs to be done, running `$ util/sync.js -D`. This
needs to run while *insight-api* is shut off. See details at: **Synchronization**.
## IMPORTANT: v0.2 Caching schema
In v0.2 a new cache schema has been introduced. Only information from transactions with
INSIGHT_SAFE_CONFIRMATIONS+ settings will be cached (by default SAFE_CONFIRMATIONS=6). There
are 3 different caches:
* nr. of confirmations
* transaction spent information
* scriptPubKey for unspent transactions
Cache data is only populated on request, i.e., only after accessing the required data for
the first time, the information is cached, there is not pre-caching procedure. To ignore
cache by default, use INSIGHT_IGNORE_CACHE. Also, address related calls support `?noCache=1`
to ignore the cache in a particular API request.
## Prerequisites ## Prerequisites
@ -146,6 +127,19 @@ To run the tests
Contributions and suggestions are welcome at [insight-api github repository](https://github.com/bitpay/insight-api). Contributions and suggestions are welcome at [insight-api github repository](https://github.com/bitpay/insight-api).
### Caching schema
Since v0.2 a new cache schema has been introduced. Only information from transactions with
INSIGHT_SAFE_CONFIRMATIONS settings will be cached (by default SAFE_CONFIRMATIONS=6). There
are 3 different caches:
* nr. of confirmations
* transaction spent information
* scriptPubKey for unspent transactions
Cache data is only populated on request, i.e., only after accessing the required data for
the first time, the information is cached, there is not pre-caching procedure. To ignore
cache by default, use INSIGHT_IGNORE_CACHE. Also, address related calls support `?noCache=1`
to ignore the cache in a particular API request.
## API ## API