31 lines
1.0 KiB
Markdown
31 lines
1.0 KiB
Markdown
|
bloom
|
||
|
|
=====
|
||
|
|
|
||
|
|
[](https://travis-ci.org/btcsuite/btcutil)
|
||
|
|
[](http://copyfree.org)
|
||
|
|
[](http://godoc.org/github.com/btcsuite/btcutil/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.
|
||
|
|
|
||
|
|
## Installation and Updating
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ go get -u github.com/btcsuite/btcutil/bloom
|
||
|
|
```
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
* [NewFilter Example](http://godoc.org/github.com/btcsuite/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](http://copyfree.org) ISC
|
||
|
|
License.
|