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

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

Store blocks, transactions, and balances for Bitcoin or Bitcoin Cash, and make that information via REST API.


[Skip to Readme]
Versions [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
Change log CHANGELOG.md
Dependencies aeson, base (>=4.9 && <5), bytestring, cereal, conduit, containers, data-default, filepath, hashable, haskoin-core, haskoin-node, haskoin-store, http-types, monad-logger, mtl, network, nqe, optparse-applicative, random, resourcet, rocksdb-haskell, rocksdb-query, scotty, string-conversions, text, time, transformers, unliftio, unordered-containers, uuid [details]
License LicenseRef-PublicDomain
Author Jean-Pierre Rupp
Maintainer xenog@protonmail.com
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 xenog at Wed Jun 12 12:32:17 UTC 2019
Distributions NixOS:0.16.5
Executables haskoin-store
Downloads 6309 total (1062 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2019-06-12 [all 3 reports]

Modules

  • Haskoin
    • Haskoin.Store
  • Paths_haskoin_store

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for haskoin-store-0.16.3

[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