blockbook

command module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 21, 2019 License: AGPL-3.0 Imports: 20 Imported by: 0

README

Go Report Card

Blockbook

WARNING: Blockbook is currently in the state of heavy development. We may implement at any time backwards incompatible changes that require full reindexation of the database. Also, do not expect this documentation to be always up to date.

Blockbook is back-end service for Trezor wallet. Main features of Blockbook are:

  • create missing indexes in the blockchain - index of addresses and address balances
  • allow fast searches in the index of addresses
  • implement parts Insight socket.io interface as required by Trezor wallet
  • support of multiple coins
  • simple blockchain explorer for implemented coins
  • scripts for easy creation of debian packages for backend and blockbook

Build and installation instructions

Officially supported platform is Debian Linux and AMD64 architecture.

Memory and disk requirements for initial synchronization of Bitcoin mainnet are around 32 GB RAM and over 150 GB of disk size. After initial synchronization, fully synchronized instance takes around 10 GB RAM. Other coins should have lower requirements depending on size of their block chain. Note that fast SSD disks are highly recommended.

User installation guide is here.

Developer build guide is here.

Contribution guide is here.

Implemented coins

The most significant coins implemented by Blockbook are:

  • Bitcoin, Bcash, Bgold, ZCash, Dash, Litecoin

Incomplete, experimental support is for:

  • Ethereum, Ethereum Classic

Testnets for some coins are also supported, for example:

  • Bitcoin Testnet, Bcash Testnet, ZCash Testnet, Ethereum Testnet Ropsten

List of all implemented coins is in the registry of ports.

Data storage in RocksDB

Blockbook stores data the key-value store RocksDB. Database format is described here.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package bchain is a generated protocol buffer package.
Package bchain is a generated protocol buffer package.
coins/eth
Package eth is a generated protocol buffer package.
Package eth is a generated protocol buffer package.
build
contrib
scripts
usr/bin/go run $0 $@ ; exit
usr/bin/go run $0 $@ ; exit
Package tests provides functions for loading and running integration tests
Package tests provides functions for loading and running integration tests
rpc
Package rpc implements integration tests of blockchain RPC layer
Package rpc implements integration tests of blockchain RPC layer
sync
Package sync implements integration tests of synchronization code
Package sync implements integration tests of synchronization code

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL