# eth-bloom
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/eth-bloom)
[](https://badge.fury.io/py/eth-bloom)
[](https://pypi.python.org/pypi/eth-bloom)
A python implementation of the bloom filter used by Ethereum.
> This library and repository was previously located at https://github.com/pipermerriam/ethereum-bloom. It was transferred to the Ethereum foundation github in November 2017 and renamed to `eth-bloom`. The PyPi package was also renamed from `ethereum-bloom` to \`eth-bloom.
Read more in the documentation below. [View the change log](https://github.com/ethereum/eth-bloom/blob/main/CHANGELOG.rst).
For more information on what Ethereum Bloom Filters are see [here](what_is_eth-bloom.txt).
## Installation
```sh
python -m pip install eth-bloom
```
## Usage
The `BloomFilter` object
```python
>>> from eth_bloom import BloomFilter
>>> b = BloomFilter()
>>> b'a value' in b # check whether a value is present
False
>>> b.add(b'a value') # add a single value
>>> b'a value' in b
True
>>> int(b) # cast to an integer
3458628712844765018311492773359360516229024449585949240367644166080576879632652362184119765613545163153674691520749911733485693171622325900647078772681584616740134230153806267998022370194756399579977294154062696916779055028045657302214591620589415314367270329881298073237757853875497241510733954508399863880080986777555986663988492288946856978031023631618215522505971170427986911575695114157059398791122395379400594948096
>>> bin(b) # cast to a binary string
'0b100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
```
You can also add an iterable of items to a bloom filter.
```python
>>> b = BloomFilter()
>>> b'value-a' in b
False
>>> b'value-b' in b
False
>>> b.extend([b'value-a', b'value-b'])
>>> b'value-a' in b
True
>>> b'value-b' in b
True
```
You can initialize a bloom filter from an iterable of byte strings.
```python
>>> b = BloomFilter.from_iterable([b'value-a', b'value-b']) # initialize from an iterable of values.
>>> b'value-a' in b
True
>>> b'value-b' in b
True
```
You can initialize a bloom filter from the integer representation of the bloom bits.
```python
>>> b = BloomFilter(3458628712844765018311492773359360516229024449585949240367644166080576879632652362184119765613545163153674691520749911733485693171622325900647078772681584616740134230153806267998022370194756399579977294154062696916779055028045657302214591620589415314367270329881298073237757853875497241510733954508399863880080986777555986663988492288946856978031023631618215522505971170427986911575695114157059398791122395379400594948096)
>>> b'a value' in b
True
```
You can also merge bloom filters
```python
>>> from eth_bloom import BloomFilter
>>> b1 = BloomFilter()
>>> b2 = BloomFilter()
>>> b1.add(b'a')
>>> b1.add(b'common')
>>> b2.add(b'b')
>>> b2.add(b'common')
>>> b'a' in b1
True
>>> b'b' in b1
False
>>> b'common' in b1
True
>>> b'a' in b2
False
>>> b'b' in b2
True
>>> b'common' in b2
True
>>> b3 = b1 + b2 # using addition
>>> b'a' in b3
True
>>> b'b' in b3
True
>>> b'common' in b3
True
>>> b4 = b1 | b2 # or using bitwise or
>>> b'a' in b4
True
>>> b'b' in b4
True
>>> b'common' in b4
True
>>> b1 |= b2 # or using in-place operations (works with += too)
>>> b'a' in b1
True
>>> b'b' in b1
True
>>> b'common' in b1
True
```
## Developer Setup
If you would like to hack on eth-bloom, please check out the [Snake Charmers
Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
for information on how we do:
- Testing
- Pull Requests
- Documentation
We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once
installed, it will run automatically with every commit. You can also run it manually
with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you
can do so with `git commit --no-verify`.
### Development Environment Setup
You can set up your dev environment with:
```sh
git clone git@github.com:ethereum/eth-bloom.git
cd eth-bloom
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
```
### Release setup
To release a new version:
```sh
make release bump=$$VERSION_PART_TO_BUMP$$
```
#### How to bumpversion
The version format for this repo is `{major}.{minor}.{patch}` for stable, and
`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).
To issue the next version in line, specify which part to bump,
like `make release bump=minor` or `make release bump=devnum`. This is typically done from the
main branch, except when releasing a beta (in which case the beta is released from main,
and the previous stable branch is released from said branch).
If you are in a beta version, `make release bump=stage` will switch to a stable.
To issue an unstable version when the current version is stable, specify the
new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`
Raw data
{
"_id": null,
"home_page": "https://github.com/ethereum/eth-bloom",
"name": "eth-bloom",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum blockchain evm trie merkle",
"author": "The Ethereum Foundation",
"author_email": "snakecharmers@ethereum.org",
"download_url": "https://files.pythonhosted.org/packages/89/d6/9c345601de27b536dc8b0f4c1d6cb84fe76a47de9ac02753f58deae59c86/eth_bloom-3.1.0.tar.gz",
"platform": null,
"description": "# eth-bloom\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/eth-bloom)\n[](https://badge.fury.io/py/eth-bloom)\n[](https://pypi.python.org/pypi/eth-bloom)\n\nA python implementation of the bloom filter used by Ethereum.\n\n> This library and repository was previously located at https://github.com/pipermerriam/ethereum-bloom. It was transferred to the Ethereum foundation github in November 2017 and renamed to `eth-bloom`. The PyPi package was also renamed from `ethereum-bloom` to \\`eth-bloom.\n\nRead more in the documentation below. [View the change log](https://github.com/ethereum/eth-bloom/blob/main/CHANGELOG.rst).\n\nFor more information on what Ethereum Bloom Filters are see [here](what_is_eth-bloom.txt).\n\n## Installation\n\n```sh\npython -m pip install eth-bloom\n```\n\n## Usage\n\nThe `BloomFilter` object\n\n```python\n>>> from eth_bloom import BloomFilter\n>>> b = BloomFilter()\n>>> b'a value' in b # check whether a value is present\nFalse\n>>> b.add(b'a value') # add a single value\n>>> b'a value' in b\nTrue\n>>> int(b) # cast to an integer\n3458628712844765018311492773359360516229024449585949240367644166080576879632652362184119765613545163153674691520749911733485693171622325900647078772681584616740134230153806267998022370194756399579977294154062696916779055028045657302214591620589415314367270329881298073237757853875497241510733954508399863880080986777555986663988492288946856978031023631618215522505971170427986911575695114157059398791122395379400594948096\n>>> bin(b) # cast to a binary string\n'0b100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'\n```\n\nYou can also add an iterable of items to a bloom filter.\n\n```python\n>>> b = BloomFilter()\n>>> b'value-a' in b\nFalse\n>>> b'value-b' in b\nFalse\n>>> b.extend([b'value-a', b'value-b'])\n>>> b'value-a' in b\nTrue\n>>> b'value-b' in b\nTrue\n```\n\nYou can initialize a bloom filter from an iterable of byte strings.\n\n```python\n>>> b = BloomFilter.from_iterable([b'value-a', b'value-b']) # initialize from an iterable of values.\n>>> b'value-a' in b\nTrue\n>>> b'value-b' in b\nTrue\n```\n\nYou can initialize a bloom filter from the integer representation of the bloom bits.\n\n```python\n>>> b = BloomFilter(3458628712844765018311492773359360516229024449585949240367644166080576879632652362184119765613545163153674691520749911733485693171622325900647078772681584616740134230153806267998022370194756399579977294154062696916779055028045657302214591620589415314367270329881298073237757853875497241510733954508399863880080986777555986663988492288946856978031023631618215522505971170427986911575695114157059398791122395379400594948096)\n>>> b'a value' in b\nTrue\n```\n\nYou can also merge bloom filters\n\n```python\n>>> from eth_bloom import BloomFilter\n>>> b1 = BloomFilter()\n>>> b2 = BloomFilter()\n>>> b1.add(b'a')\n>>> b1.add(b'common')\n>>> b2.add(b'b')\n>>> b2.add(b'common')\n>>> b'a' in b1\nTrue\n>>> b'b' in b1\nFalse\n>>> b'common' in b1\nTrue\n>>> b'a' in b2\nFalse\n>>> b'b' in b2\nTrue\n>>> b'common' in b2\nTrue\n>>> b3 = b1 + b2 # using addition\n>>> b'a' in b3\nTrue\n>>> b'b' in b3\nTrue\n>>> b'common' in b3\nTrue\n>>> b4 = b1 | b2 # or using bitwise or\n>>> b'a' in b4\nTrue\n>>> b'b' in b4\nTrue\n>>> b'common' in b4\nTrue\n>>> b1 |= b2 # or using in-place operations (works with += too)\n>>> b'a' in b1\nTrue\n>>> b'b' in b1\nTrue\n>>> b'common' in b1\nTrue\n```\n\n## Developer Setup\n\nIf you would like to hack on eth-bloom, please check out the [Snake Charmers\nTactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)\nfor information on how we do:\n\n- Testing\n- Pull Requests\n- Documentation\n\nWe use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once\ninstalled, it will run automatically with every commit. You can also run it manually\nwith `make lint`. If you need to make a commit that skips the `pre-commit` checks, you\ncan do so with `git commit --no-verify`.\n\n### Development Environment Setup\n\nYou can set up your dev environment with:\n\n```sh\ngit clone git@github.com:ethereum/eth-bloom.git\ncd eth-bloom\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\n### Release setup\n\nTo release a new version:\n\n```sh\nmake release bump=$$VERSION_PART_TO_BUMP$$\n```\n\n#### How to bumpversion\n\nThe version format for this repo is `{major}.{minor}.{patch}` for stable, and\n`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).\n\nTo issue the next version in line, specify which part to bump,\nlike `make release bump=minor` or `make release bump=devnum`. This is typically done from the\nmain branch, except when releasing a beta (in which case the beta is released from main,\nand the previous stable branch is released from said branch).\n\nIf you are in a beta version, `make release bump=stage` will switch to a stable.\n\nTo issue an unstable version when the current version is stable, specify the\nnew version explicitly, like `make release bump=\"--new-version 4.0.0-alpha.1 devnum\"`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python implementation of the bloom filter used by Ethereum",
"version": "3.1.0",
"project_urls": {
"Homepage": "https://github.com/ethereum/eth-bloom"
},
"split_keywords": [
"ethereum",
"blockchain",
"evm",
"trie",
"merkle"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81e5251bda1d3f3cff230fa39e95d41141c1b44e8f55c101c5f593ccf5a31b63",
"md5": "1b73ad2a932cf4f4111c56ef2560d1d8",
"sha256": "c96b2dd6cafa407373bca1a9d74b650378ba672d5b17f2771bf7d3c3aaa7651c"
},
"downloads": -1,
"filename": "eth_bloom-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b73ad2a932cf4f4111c56ef2560d1d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 5785,
"upload_time": "2025-01-08T19:05:17",
"upload_time_iso_8601": "2025-01-08T19:05:17.757716Z",
"url": "https://files.pythonhosted.org/packages/81/e5/251bda1d3f3cff230fa39e95d41141c1b44e8f55c101c5f593ccf5a31b63/eth_bloom-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "89d69c345601de27b536dc8b0f4c1d6cb84fe76a47de9ac02753f58deae59c86",
"md5": "18fe52db1db7fdfcbcce22f146ec4929",
"sha256": "4bc918f6fde44334e92b23cfb345db961e2e3af620535cbc872444f7a143cb88"
},
"downloads": -1,
"filename": "eth_bloom-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "18fe52db1db7fdfcbcce22f146ec4929",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 9807,
"upload_time": "2025-01-08T19:05:18",
"upload_time_iso_8601": "2025-01-08T19:05:18.945091Z",
"url": "https://files.pythonhosted.org/packages/89/d6/9c345601de27b536dc8b0f4c1d6cb84fe76a47de9ac02753f58deae59c86/eth_bloom-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 19:05:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "eth-bloom",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "eth-bloom"
}
JSON
