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
Change log CHANGELOG.md
Dependencies aeson, base (>=4.9 && <5), binary, bytestring, cereal, conduit, containers, data-default, directory, filepath, hashable, haskoin-core, haskoin-node, haskoin-store, http-types, monad-logger, mtl, network, nqe, optparse-applicative, random, rocksdb-haskell, rocksdb-query, scotty, string-conversions, text, time, transformers, unliftio, unordered-containers [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 Thu Mar 14 09:51:24 UTC 2019
Distributions NixOS:0.11.2
Executables haskoin-store
Downloads 3071 total (1042 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for haskoin-store-0.11.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.
  • Guaranteed consistency within a request.

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.

API Documentation

Notes

Transaction Ordering

Transactions are returned in reverse blockchain or mempool order, meaning that the latest transactions are shown first, starting from the mempool and then from the highest block in the blockchain. If many transactions are returned from the same block, they are in reverse order as they appear in the block, meaning the latest transaction in the block comes first.

After the November 2018 hard fork Bitcoin Cash transactions are not stored in a block in topological order. If multiple transactions in one block depend on each other, they may appear in the "wrong" order. This is intentional and does not need to be fixed.