mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 09:50:08 +01:00
Code Issues Projects Releases Wiki Activity
f6ad7eb2c9
btcd/blockchain/indexers
History
Dave Collins bd4e64d1d4 chainhash: Abstract hash logic to new package. (#729) 
This is mostly a backport of some of the same modifications made in
Decred along with a few additional things cleaned up.  In particular,
this updates the code to make use of the new chainhash package.

Also, since this required API changes anyways and the hash algorithm is
no longer tied specifically to SHA, all other functions throughout the
code base which had "Sha" in their name have been changed to Hash so
they are not incorrectly implying the hash algorithm.

The following is an overview of the changes:

- Remove the wire.ShaHash type
- Update all references to wire.ShaHash to the new chainhash.Hash type
- Rename the following functions and update all references:
  - wire.BlockHeader.BlockSha -> BlockHash
  - wire.MsgBlock.BlockSha -> BlockHash
  - wire.MsgBlock.TxShas -> TxHashes
  - wire.MsgTx.TxSha -> TxHash
  - blockchain.ShaHashToBig -> HashToBig
  - peer.ShaFunc -> peer.HashFunc
- Rename all variables that included sha in their name to include hash
  instead
- Update for function name changes in other dependent packages such as
  btcutil
- Update copyright dates on all modified files
- Update glide.lock file to use the required version of btcutil
2016-08-08 14:04:33 -05:00
..
addrindex_test.go indexers: Implement optional tx/address indexes. 2016-04-11 17:16:42 -05:00
addrindex.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
blocklogger.go indexers: Implement optional tx/address indexes. 2016-04-11 17:16:42 -05:00
common.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
log.go indexers: Implement optional tx/address indexes. 2016-04-11 17:16:42 -05:00
manager.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
README.md indexers: Implement optional tx/address indexes. 2016-04-11 17:16:42 -05:00
txindex.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00

README.md

indexers

[Build Status] (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

[GoDoc] (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

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

License

Package indexers is licensed under the copyfree ISC License.