RanchiMall/blockbook
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Martin Boehm 2018-05-30 17:15:22 +02:00
parent e5171c7487
commit 5020b1b3ae
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,14 +1,18 @@
# blockbook # blockbook
## Install using Docker: ## **blockbook is currently in the state of heavy development, do not expect this documentation to be up to date**
## Build and install using docker
Run in the project root
``` ```
git clone https://github.com/jpochyla/blockbook.git make all
cd blockbook/docker
./build.sh
``` ```
## Install to create blockbook debian packages.
## Install manually
Setup go environment (Debian 9): Setup go environment (Debian 9):
@ -72,7 +76,10 @@ Blockbook logs only to stderr, logging to files is disabled. Verbosity of logs c
- [BTC](bchain/coins/btc/btc.md) - [BTC](bchain/coins/btc/btc.md)
- [BTC Testnet](bchain/coins/btc/btctestnet.md) - [BTC Testnet](bchain/coins/btc/btctestnet.md)
- BCH
- BCH Testnet
- [ZCash](bchain/coins/zec/zec.md) - [ZCash](bchain/coins/zec/zec.md)
- ZCash Testnet
- [Ethereum](bchain/coins/eth/eth.md) - [Ethereum](bchain/coins/eth/eth.md)
- [Ethereum Ropsten Testnet](bchain/coins/eth/ethropsten.md) - [Ethereum Ropsten Testnet](bchain/coins/eth/ethropsten.md)
@ -141,10 +148,8 @@ The data are separated to different column families:
## Todo ## Todo
- add db data version (column data version) checking to db to avoid data corruption - add db data version (column data version) checking to db to avoid data corruption
- update used paths and users according to specification by system admin
- improve txcache (time of storage, number/size of cached txs, purge cache) - improve txcache (time of storage, number/size of cached txs, purge cache)
- collect blockbook stats (number of items in indexes, ) - collect blockbook stats (number of items in indexes, etc)
- optimize mempool (use non verbose get transaction, possibly parallelize)
- update documentation - update documentation
- create/integrate blockchain explorer - create/integrate blockchain explorer
- support all coins from https://github.com/trezor/trezor-common/blob/master/coins.json - support all coins from https://github.com/trezor/trezor-common/blob/master/coins.json
@ -154,6 +159,8 @@ The data are separated to different column families:
- tests - tests
- fix program dependencies to concrete versions - fix program dependencies to concrete versions
- protect socket.io interface against illicit usage - protect socket.io interface against illicit usage
- ~~optimize mempool (use non verbose get transaction, possibly parallelize)~~
- ~~update used paths and users according to specification by system admin~~
- ~~cleanup of the socket.io - do not send unnecessary data~~ - ~~cleanup of the socket.io - do not send unnecessary data~~
- ~~handle different versions of Bitcoin Core~~ - ~~handle different versions of Bitcoin Core~~
- ~~log live traffic from production bitcore server and replay it in blockbook~~ - ~~log live traffic from production bitcore server and replay it in blockbook~~