btcd/blockchain/indexers
Calvin Kim e27fcac9cd blockchain/indexers: add functions to report init status
This change is part of the effort to add pruning support to btcd.

The added *Initialized() functions to each of the indexers allow for
callers to check if each of the indexes have been created.  It's
useful for ux improvements where we force the user to manually drop
indexes that aren't compatible with pruning when the user enables
pruning.
2023-08-23 00:46:53 +09:00
..
addrindex.go blockchain/indexers: add functions to report init status 2023-08-23 00:46:53 +09:00
addrindex_test.go build: clean linter warnings 2020-05-13 08:58:39 -04:00
blocklogger.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
cfindex.go blockchain/indexers: add functions to report init status 2023-08-23 00:46:53 +09:00
common.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
log.go
manager.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
txindex.go blockchain/indexers: add functions to report init status 2023-08-23 00:46:53 +09:00

indexers

Build Status ISC License GoDoc

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

Installation

$ go get -u github.com/btcsuite/btcd/blockchain/indexers

License

Package indexers is licensed under the copyfree ISC License.