vendor/github.com/btcsuite/btcd/blockchain/indexers/README.md

   1 indexers
   2 ========
   3
   4 [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
   5 [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
   6 [![GoDoc](https://godoc.org/github.com/btcsuite/btcd/blockchain/indexers?status.png)](http://godoc.org/github.com/btcsuite/btcd/blockchain/indexers)
   7
   8 Package indexers implements optional block chain indexes.
   9
  10 These indexes are typically used to enhance the amount of information available
  11 via an RPC interface.
  12
  13 ## Supported Indexers
  14
  15 - Transaction-by-hash (txbyhashidx) Index
  16   - Creates a mapping from the hash of each transaction to the block that
  17     contains it along with its offset and length within the serialized block
  18 - Transaction-by-address (txbyaddridx) Index
  19   - Creates a mapping from every address to all transactions which either credit
  20     or debit the address
  21   - Requires the transaction-by-hash index
  22
  23 ## Installation
  24
  25 ```bash
  26 $ go get -u github.com/btcsuite/btcd/blockchain/indexers
  27 ```
  28
  29 ## License
  30
  31 Package indexers is licensed under the [copyfree](http://copyfree.org) ISC
  32 License.