45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
|
indexers
|
||
|
|
========
|
||
|
|
|
||
|
|
[]
|
||
|
|
(https://travis-ci.org/btcsuite/btcd)
|
||
|
|
|
||
|
|
Package indexers implements optional block chain indexes.
|
||
|
|
|
||
|
|
These indexes are typically used to enhance the amount of information available
|
||
|
|
via an RPC interface.
|
||
|
|
|
||
|
|
## Supported Indexers
|
||
|
|
|
||
|
|
- Transaction-by-hash (txbyhashidx) Index
|
||
|
|
- Creates a mapping from the hash of each transaction to the block that
|
||
|
|
contains it along with its offset and length within the serialized block
|
||
|
|
- Transaction-by-address (txbyaddridx) Index
|
||
|
|
- Creates a mapping from every address to all transactions which either credit
|
||
|
|
or debit the address
|
||
|
|
- Requires the transaction-by-hash index
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
[]
|
||
|
|
(http://godoc.org/github.com/btcsuite/btcd/blockchain/indexers)
|
||
|
|
|
||
|
|
Full `go doc` style documentation for the project can be viewed online without
|
||
|
|
installing this package by using the GoDoc site here:
|
||
|
|
http://godoc.org/github.com/btcsuite/btcd/blockchain/indexers
|
||
|
|
|
||
|
|
You can also view the documentation locally once the package is installed with
|
||
|
|
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
|
||
|
|
http://localhost:6060/pkg/github.com/btcsuite/btcd/blockchain/indexers
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ go get -u github.com/btcsuite/btcd/blockchain/indexers
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Package indexers is licensed under the [copyfree](http://copyfree.org) ISC
|
||
|
|
License.
|