github.com/decred/dcrd/blockchain@v1.2.1/indexers/README.md (about)

     1  indexers
     2  ========
     3  
     4  [![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)](https://travis-ci.org/decred/dcrd)
     5  [![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
     6  [![GoDoc](https://godoc.org/github.com/decred/dcrd/blockchain/indexers?status.png)](https://godoc.org/github.com/decred/dcrd/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  - Address-ever-seen (existsaddridx) Index
    23    - Stores a key with an empty value for every address that has ever existed 
    24      and was seen by the client
    25    - Requires the transaction-by-hash index
    26  - Committed Filter (cfindexparentbucket) Index
    27    - Stores all committed filters and committed filter headers for all blocks in
    28      the main chain
    29  
    30  ## Installation
    31  
    32  ```bash
    33  $ go get -u github.com/decred/dcrd/blockchain/indexers
    34  ```
    35  
    36  ## License
    37  
    38  Package indexers is licensed under the [copyfree](http://copyfree.org) ISC
    39  License.