zcash-hackworks
/
insight-ui-zcash
mirror of https://github.com/zcash-hackworks/insight-ui-zcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README changes

This commit is contained in:
Manuel Araoz 2014-02-14 17:14:49 -03:00
parent ab62abf8f5
commit 2dfffa1d0b
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -61,22 +61,22 @@ BITCOIND_DATADIR # bitcoind datadir for livenet, or datadir/testnet3 for te
INSIGHT_NETWORK [= 'livenet' | 'testnet'] INSIGHT_NETWORK [= 'livenet' | 'testnet']
``` ```
Make sure that bitcoind is configured to [accept incoming connections using 'rpcallowip'] (https://en.bitcoin.it/wiki/Running_Bitcoin). Make sure that bitcoind is configured to [accept incoming connections using 'rpcallowip'](https://en.bitcoin.it/wiki/Running_Bitcoin).
In case the network is changed (testnet to livenet or vice versa) levelDB database needs to be deleted. This can be performed running: In case the network is changed (testnet to livenet or vice versa) levelDB database needs to be deleted. This can be performed running:
```util/sync.js -D``` and waiting for *insight* to synchronize again. Once the database is deleted, the sync.js process can be safely interrupted (CTRL+C) and continued from the synchronization process embedded in main app. ```util/sync.js -D``` and waiting for *insight* to synchronize again. Once the database is deleted, the sync.js process can be safely interrupted (CTRL+C) and continued from the synchronization process embedded in main app.
## Syncronization ## Synchronization
The initial syncronization process scans the blockchain from the paired bitcoind server to update addresses and balances. *insight* needs one (and only one) trusted bitcoind node to run. This node must have finished downloading the blockchain befure running *insight*. The initial synchronization process scans the blockchain from the paired bitcoind server to update addresses and balances. *insight* needs one (and only one) trusted bitcoind node to run. This node must have finished downloading the blockchain befure running *insight*.
While *insight* is synchronizing the website can be accessed (the sync process is embedded in the webserver), but there will be inconsistencies on the data. The 'sync' status is shown on the top-right of all pages. While *insight* is synchronizing the website can be accessed (the sync process is embedded in the webserver), but there may be missing data or incorrect balances for addresses. The 'sync' status is shown on the top-right of all pages.
The blockchain can be read from bitcoind's raw dat files or RPC access. Reading the information from the dat files is much faster so it is the recommended alternative. .dat files are scanned in the default location for each platform, in case a non standard location is used, it needs to be defined (see Configuration). The synchronization type been use can be seen at the Status page in *insight* front-end. As of February 2014, using .dat files the sync process takes 7hrs for livenet (20min for testnet). The blockchain can be read from bitcoind's raw `.dat` files or RPC interface. Reading the information from the `.dat` files is much faster so it's the recommended (and default) alternative. `.dat` files are scanned in the default location for each platform. In case a non-standard location is used, it needs to be defined (see the Configuration section). The synchronization type being used can be seen at the [Status page](http://localhost:3001/status). As of February 2014, using `.dat` files the sync process takes 7 hrs. for livenet and 20 mins. for testnet.
While synchronizing the blockchain, *insight* listen for new blocks and transactions relayed by the paired bitcoind server. Those are also stored on *insight* database. In case *insight* is shutdown for a period of time, restarting *insight* will trigger a partial (historic) syncronization of the blockchain. Depending the size of that synchronization process, a reverse RPC or forward .dat file schema will be used. While synchronizing the blockchain, *insight* listens for new blocks and transactions relayed by the bitcoind node. Those are also stored on *insight*'s database. In case *insight* is shutdown for a period of time, restarting it will trigger a partial (historic) synchronization of the blockchain. Depending on the size of that synchronization task, a reverse RPC or forward `.dat` syncing strategy will be used.
If bitcoind is shutdown, *insight* need to be stopped and restarted once bitcoind is restarted. If bitcoind is shutdown, *insight* needs to be stopped and restarted once bitcoind is restarted.
### Syncing old blockchain data manualy ### Syncing old blockchain data manualy
@ -86,7 +86,7 @@ If bitcoind is shutdown, *insight* need to be stopped and restarted once bitcoin
Check utils/sync.js --help for options, particulary -D to erase the current DB. Check utils/sync.js --help for options, particulary -D to erase the current DB.
*NOTE* that there is no need to run this manually since the historic syncronization is embedded on the web application, so by running you will trigger the historic sync automatically. *NOTE* that there is no need to run this manually since the historic synchronization is embedded on the web application, so by running you will trigger the historic sync automatically.
### DB storage requirement ### DB storage requirement