package
1.0.2
Repository: https://github.com/btcsuite/btcutil.git
Documentation: pkg.go.dev

# README

bloom

Build Status ISC License GoDoc

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

$ go get -u github.com/btcsuite/btcutil/bloom

Examples

  • NewFilter Example
    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.

# Functions

LoadFilter creates a new Filter instance with the given underlying wire.MsgFilterLoad.
MurmurHash3 implements a non-cryptographic hash function using the MurmurHash3 algorithm.
NewFilter creates a new bloom filter instance, mainly to be used by SPV clients.
NewMerkleBlock returns a new *wire.MsgMerkleBlock and an array of the matched transaction index numbers based on the passed block and filter.

# Structs

Filter defines a bitcoin bloom filter that provides easy manipulation of raw filter data.