github.com/dashpay/godash@v0.0.0-20160726055534-e038a21e0e3d/blockchain/indexers/README.md (about)

     1  indexers
     2  ========
     3  
     4  [![Build Status](https://travis-ci.org/dashpay/godash.png?branch=master)]
     5  (https://travis-ci.org/dashpay/godash)
     6  
     7  Package indexers implements optional block chain indexes.
     8  
     9  These indexes are typically used to enhance the amount of information available
    10  via an RPC interface.
    11  
    12  ## Supported Indexers
    13  
    14  - Transaction-by-hash (txbyhashidx) Index
    15    - Creates a mapping from the hash of each transaction to the block that
    16      contains it along with its offset and length within the serialized block
    17  - Transaction-by-address (txbyaddridx) Index
    18    - Creates a mapping from every address to all transactions which either credit
    19      or debit the address
    20    - Requires the transaction-by-hash index
    21  
    22  ## Documentation
    23  
    24  [![GoDoc](https://godoc.org/github.com/dashpay/godash/blockchain/indexers?status.png)]
    25  (http://godoc.org/github.com/dashpay/godash/blockchain/indexers)
    26  
    27  Full `go doc` style documentation for the project can be viewed online without
    28  installing this package by using the GoDoc site here:
    29  http://godoc.org/github.com/dashpay/godash/blockchain/indexers
    30  
    31  You can also view the documentation locally once the package is installed with
    32  the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
    33  http://localhost:6060/pkg/github.com/dashpay/godash/blockchain/indexers
    34  
    35  ## Installation
    36  
    37  ```bash
    38  $ go get -u github.com/dashpay/godash/blockchain/indexers
    39  ```
    40  
    41  ## License
    42  
    43  Package indexers is licensed under the [copyfree](http://copyfree.org) ISC
    44  License.