# bloom-filter

> A bloom filter suitable for use in Bitcoin Connection Bloom Filtering as part of [BIP37](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki).

Latest version **0.2.0** (published 2015-03-16) · 0 weekly downloads

## Install

```sh
npm install bloom-filter
pnpm add bloom-filter
yarn add bloom-filter
bun add bloom-filter
```

## Health

**Score 18/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-03-16 |
| First published | 2015-01-19 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/bloom-filter) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 38 |
| Maintainers | braydonf |

## Links

- npm: https://www.npmjs.com/package/bloom-filter
- Repository: http://github.com/bitpay/bloom-filter
- Homepage: https://github.com/bitpay/bloom-filter
- Issues: https://github.com/bitpay/bloom-filter/issues
- npm.io page: https://npm.io/package/bloom-filter

## Recent versions

- 0.2.0 (latest) — 2015-03-16
- 0.1.1 — 2015-01-19
- 0.1.0 — 2015-01-19

## README

# bloom-filter

A bloom filter suitable for use in Bitcoin Connection Bloom Filtering as part of [BIP37](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki).

## Get Started

```bash
npm install bloom-filter
```

```javascript

var BloomFilter = require('bloom-filter');

// convenient method to initialize the filter
var numberOfElements = 3;
var falsePositiveRate = 0.01;
var filter = BloomFilter.create(numberofElements, falsePositiveRate);

// elements
var a = new Buffer('99108ad8ed9bb6274d3980bab5a85c048f0950c8', 'hex');
var b = new Buffer('19108ad8ed9bb6274d3980bab5a85c048f0950c8', 'hex');
var c = new Buffer('b5a2c786d9ef4658287ced5914b37a1b4aa32eee', 'hex');

// insert elements
filter.insert(a);
filter.insert(b);

// check if elements match
assert(!filter.contains(c));
assert(filter.contains(a));

// reinstantiate from an object
var serialized = filter.toObject();
var filter = new BloomFilter(serialized);

// initialize directly
var filter = new BloomFilter({
  vData: [], // the data of the filter
  nHashFucs: 3, // the number of hash functions to use
  nTweak: 2147483649, // the seed used for the hash fuctions
  nFlags: 0 // flags used to update the filter when matched
});


```
## License

Code released under [the MIT license](https://github.com/bitpay/bloom-filter/blob/master/LICENSE).

Copyright 2015 BitPay, Inc.

---
_Source: https://npm.io/package/bloom-filter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._