History

Dave Collins 17dc3fb3b6 Really add READEME.md for bloom package.		2014-07-09 20:43:24 -05:00
..
cov_report.sh	Cleanup and finish BIP0037 bloom filter API.	2014-07-09 13:28:58 -05:00
example_test.go	Add READEME.md for bloom package.	2014-07-09 20:41:22 -05:00
filter.go	Cleanup and finish BIP0037 bloom filter API.	2014-07-09 13:28:58 -05:00
filter_test.go	Add license header to all bloom package files.	2014-07-09 20:01:45 -05:00
merkleblock.go	Add license header to all bloom package files.	2014-07-09 20:01:45 -05:00
merkleblock_test.go	Add license header to all bloom package files.	2014-07-09 20:01:45 -05:00
murmurhash3.go	Add license header to all bloom package files.	2014-07-09 20:01:45 -05:00
murmurhash3_test.go	Add license header to all bloom package files.	2014-07-09 20:01:45 -05:00
README.md	Really add READEME.md for bloom package.	2014-07-09 20:43:24 -05:00
test_coverage.txt	Cleanup and finish BIP0037 bloom filter API.	2014-07-09 13:28:58 -05:00

README.md

bloom

Package bloom provides an API for dealing with bitcoin-specific bloom filters.

A comprehensive suite of tests is provided to ensure proper functionality. See test_coverage.txt for the gocov coverage report. Alternatively, if you are running a POSIX OS, you can run the cov_report.sh script for a real-time report. Package coinset is licensed under the liberal ISC license.

Documentation

[] (http://godoc.org/github.com/conformal/btcutil/bloom)

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/conformal/btcutil/bloom

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/conformal/btcutil/bloom

Installation

$ go get github.com/conformal/btcutil/bloom

Examples

[NewFilter Example] (http://godoc.org/github.com/conformal/btcutil/bloom#example-NewFilter)
Demonstrates how to create a new bloom filter, add a transaction hash to it, and check if the filter matches the transaction.

License

Package bloom is licensed under the copyfree ISC License.