From 67050ff3d1eb9e9692e690723193057989ba1d67 Mon Sep 17 00:00:00 2001 From: Manuel Araoz Date: Thu, 21 Aug 2014 10:21:00 -0400 Subject: [PATCH] update readme 6 --- README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5ba22873..9a449c83 100644 --- a/README.md +++ b/README.md @@ -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 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 @@ -146,6 +127,19 @@ To run the tests 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