Hackage :: [Package]

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 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.2.0, 0.2.1, 0.2.2, 0.2.3
Change log CHANGELOG.md
Dependencies aeson, base (>=4.7 && <5), bytestring, cereal, conduit, containers, directory, filepath, 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 [details]
License LicenseRef-PublicDomain
Author Jean-Pierre Rupp
Maintainer xenog@protonmail.com
Category Bitcoin, Finance, Network
Home page http://github.com/haskoin/haskoin#readme
Bug tracker http://github.com/haskoin/haskoin/issues
Source repo head: git clone https://github.com/haskoin/haskoin.git
Uploaded by xenog at Fri Sep 14 18:36:32 UTC 2018
Distributions NixOS:0.1.3, Stackage:0.2.3
Executables haskoin-store
Downloads 169 total (169 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for haskoin-store-0.2.3

[back to package description]

Haskoin Store

Full blockchain index & store featuring:

  • Address index.
  • Mempool.
  • Persistent storage using RocksDB.
  • RESTful endpoints for blockchain data.
  • Concurrent design.
  • No blocking on database access.
  • Guaranteed consistency within a request.
  • Atomic updates to prevent corruption.

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

Addresses & Balances

For every address Haskoin Store has a balance object that contains basic statistics about the address. These statistics are described below.

  • confirmed balance is that which is in the blockchain. Will always be positive or zero.
  • unconfirmed balance represent aggregate changes done by mempool transactions. Can be negative if the transactions currently in the mempool are expected to reduce the balance when all of them make it into the blockchain.
  • outputs is the count of outputs that send funds to this address. It is just a count and not a monetary value.
  • utxo is the count of outputs that send funds to this address that remain unspent, taking the mempool into account: if spent in the mempool it will not count as unspent.