haskoin-store: Storage and index for Bitcoin and Bitcoin Cash

[ bitcoin, finance, library, mit, network, program ] [ Propose Tags ]

Store and index Bitcoin or Bitcoin Cash blocks, transactions, balances and unspent outputs. All data is available via REST API in JSON or binary format. Uses in-process RocksDB database to store data. Supports Redis cache that can be shared by multiple nodes for faster access to extended public key balances, transactions and unspent outputs.


[Skip to Readme]
Versions [RSS] [faq] 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.4.0, 0.4.1, 0.4.2, 0.5.0, 0.6.0, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.6.6, 0.6.7, 0.6.8, 0.6.9, 0.7.0, 0.8.0, 0.8.1, 0.9.0, 0.9.1, 0.9.2, 0.9.3, 0.10.0, 0.10.1, 0.11.0, 0.11.1, 0.11.2, 0.12.0, 0.13.0, 0.13.1, 0.14.0, 0.14.1, 0.14.2, 0.14.3, 0.14.4, 0.14.5, 0.14.6, 0.14.7, 0.14.8, 0.14.9, 0.15.0, 0.15.1, 0.15.2, 0.16.0, 0.16.1, 0.16.2, 0.16.3, 0.16.4, 0.16.5, 0.16.6, 0.17.0, 0.17.1, 0.17.2, 0.18.0, 0.18.1, 0.18.2, 0.18.3, 0.18.4, 0.18.5, 0.18.6, 0.18.7, 0.18.8, 0.18.9, 0.18.10, 0.18.11, 0.19.0, 0.19.2, 0.19.3, 0.19.4, 0.19.5, 0.20.0, 0.20.1, 0.20.2, 0.21.0, 0.21.1, 0.21.2, 0.21.3, 0.21.4, 0.21.5, 0.21.6, 0.21.7, 0.22.0, 0.22.1, 0.22.2, 0.22.3, 0.22.4, 0.22.5, 0.23.0, 0.23.1, 0.23.2, 0.23.3, 0.23.4, 0.23.5, 0.23.6, 0.23.7, 0.23.8, 0.23.9, 0.23.10, 0.23.11, 0.23.12, 0.23.13, 0.23.14, 0.23.15, 0.23.16, 0.23.18, 0.23.19, 0.23.20, 0.23.21, 0.23.22, 0.23.23, 0.24.0, 0.25.1, 0.25.2, 0.25.3, 0.25.4, 0.26.0, 0.26.1, 0.26.2, 0.26.3, 0.26.4, 0.26.5, 0.26.6, 0.27.0, 0.28.0, 0.29.0, 0.29.1, 0.29.3, 0.30.0, 0.30.1, 0.31.0, 0.32.0, 0.32.1, 0.32.2, 0.32.3, 0.33.0, 0.33.1, 0.34.0, 0.34.1, 0.34.2, 0.34.3, 0.34.4, 0.34.5, 0.34.6, 0.34.7, 0.35.0, 0.35.1, 0.35.2, 0.36.0, 0.36.2, 0.36.4, 0.37.0, 0.37.1, 0.37.2, 0.37.3, 0.37.4, 0.37.5, 0.38.0, 0.38.1, 0.38.2, 0.38.3, 0.38.4, 0.39.0, 0.40.0, 0.40.1, 0.40.2, 0.40.3, 0.40.4, 0.40.5, 0.40.6, 0.40.7, 0.40.8, 0.40.9, 0.40.10, 0.40.11, 0.40.12, 0.40.13, 0.40.14, 0.40.15, 0.40.16, 0.40.17, 0.40.18, 0.40.19, 0.40.20, 0.40.21, 0.40.22, 0.41.0, 0.41.1, 0.41.2, 0.41.3, 0.42.0, 0.42.1, 0.42.2, 0.42.3, 0.43.0, 0.43.1, 0.44.0, 0.45.0, 0.46.0, 0.46.1, 0.46.2, 0.46.3, 0.46.4, 0.46.5, 0.46.6, 0.47.0, 0.47.1, 0.47.2, 0.47.3, 0.47.4, 0.47.5, 0.47.6, 0.48.0, 0.49.0, 0.50.0, 0.50.1, 0.50.2, 0.50.3, 0.51.0, 0.52.0, 0.52.1, 0.52.2, 0.52.3, 0.52.4, 0.52.5, 0.52.6, 0.52.7, 0.52.8, 0.52.9, 0.52.10, 0.52.11, 0.52.12, 0.52.13, 0.53.0, 0.53.1, 0.53.2, 0.53.3, 0.53.4
Change log CHANGELOG.md
Dependencies aeson (>=1.4.7.1), base (>=4.9 && <5), bytestring (>=0.10.10.0), cereal (>=0.5.8.1), conduit (>=1.3.2), containers (>=0.6.2.1), data-default (>=0.7.1.1), deepseq (>=1.4.4.0), filepath, hashable (>=1.3.0.0), haskoin-core (>=0.12.0), haskoin-node (>=0.9.21), haskoin-store, hedis (>=0.12.13), http-types (>=0.12.3), monad-logger (>=0.3.32), mtl (>=2.2.2), network (>=3.1.1.1), nqe (>=0.6.1), optparse-applicative, random (>=1.1), rocksdb-haskell (>=1.0.1), rocksdb-query (>=0.3.1), scotty (>=0.11.5), string-conversions (>=0.4.0.1), text (>=1.2.4.0), time (>=1.9.3), transformers (>=0.5.6.2), unliftio (>=0.2.12.1), unordered-containers (>=0.2.10.0), wai (>=3.2.2.1), warp (>=3.3.10) [details]
License LicenseRef-PublicDomain
Author Jean-Pierre Rupp
Maintainer jprupp@protonmail.ch
Category Bitcoin, Finance, Network
Home page http://github.com/haskoin/haskoin-store#readme
Bug tracker http://github.com/haskoin/haskoin-store/issues
Source repo head: git clone https://github.com/haskoin/haskoin-store.git
Uploaded by jprupp at 2020-04-28T15:39:46Z
Distributions NixOS:0.52.8
Executables haskoin-store
Downloads 205600 total (11363 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2020-04-28 [all 3 reports]

Modules

  • Haskoin
    • Haskoin.Store
  • Paths_haskoin_store

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for haskoin-store-0.23.2

[back to package description]

Haskoin Store

Full blockchain index & store featuring:

  • Bitcoin Cash (BCH) & Bitcoin SegWit (BTC) support.
  • Address balance, transaction, and UTXO index.
  • Mempool support (SPV).
  • XPub balance, transaction, and UTXO support.
  • Persistent storage using RocksDB.
  • RESTful endpoints for blockchain data.
  • Concurrent non-blocking transactional design.
  • JSON and Protocol Buffers serialization support.

Install

  • Get Stack.
  • Get Nix.
  • Clone this repository git clone https://github.com/haskoin/haskoin-store.
  • From the root of this repository run stack --nix build --copy-bins.
  • File will usually be installed in ~/.local/bin/haskoin-store.

Cache

A memory-based RocksDB database can be used as a cache to store:

  • Address balances.
  • Unspent outputs.

Give haskoin-store the path to a directory mapped to RAM, and it will populate a RockDB database for caching. Needs around 25 GB at the moment (May 2019).

API Documentation