Skip to main content

eth-hash: The Ethereum hashing function, keccak256, sometimes (erroneously) called sha3

Project description

Join the chat at https://gitter.im/ethereum/web3.py Build Status PyPI version Python versions Docs build

The Ethereum hashing function, keccak256, sometimes (erroneously) called sha3

Note: the similarly named pyethash has a completely different use: it generates proofs of work.

This is a low-level library, intended to be used internally by other Ethereum tools. If you’re looking for a convenient hashing tool, check out `eth_utils.keccak() <https://github.com/ethereum/eth-utils#crypto-utils>`__ which will be a little friendlier, and provide access to other helpful utilities.

Read more in the documentation on ReadTheDocs. View the change log.

Quickstart

pip install eth-hash[pycryptodome]
>>> from eth_hash.auto import keccak
>>> keccak(b'')
b"\xc5\xd2F\x01\x86\xf7#<\x92~}\xb2\xdc\xc7\x03\xc0\xe5\x00\xb6S\xca\x82';{\xfa\xd8\x04]\x85\xa4p"

See the docs for more about choosing and installing backends.

Developer setup

If you would like to hack on eth-hash, please check out the Ethereum Development Tactical Manual for information on how we do:

  • Testing

  • Pull Requests

  • Code Style

  • Documentation

Development Environment Setup

You can set up your dev environment with:

git clone git@github.com:ethereum/eth-hash.git
cd eth-hash
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]

Testing Setup

During development, you might like to have tests run on every file save.

Show flake8 errors on file change:

# Test flake8
when-changed -v -s -r -1 eth_hash/ tests/ -c "clear; flake8 eth_hash tests && echo 'flake8 success' || echo 'error'"

Run multi-process tests in one command, but without color:

# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1

Run in one thread, with color and desktop notifications:

cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on eth-hash failed'" ../tests ../eth_hash

Release setup

For Debian-like systems:

apt install pandoc

To release a new version:

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.

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"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eth-hash-0.2.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

eth_hash-0.2.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file eth-hash-0.2.0.tar.gz.

File metadata

  • Download URL: eth-hash-0.2.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for eth-hash-0.2.0.tar.gz
Algorithm Hash digest
SHA256 499dc02d098f69856d1a6dd005529c16174157d4fb2a9fe20c41f69e39f8f176
MD5 a87c796c573a9f2ffba8188c57cfa7fb
BLAKE2b-256 c7f7b7a29f683aa180fe70c070cc07a6750647e92d8ecca57c8cfa3f4f2318f2

See more details on using hashes here.

File details

Details for the file eth_hash-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: eth_hash-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for eth_hash-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b9cb34dd3cd99c85c2bd6a1420ceae39a2eee8bf080efd264bcda8be3edecc8
MD5 30f40f0242daf75bfc37c35a3dc45fd2
BLAKE2b-256 0dd80f0c8d4ccaa4c8d25524fd1ed9f5c6d9551b52b74b973f338de3f0a23111

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page