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

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.1.0a4.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

eth_hash-0.1.0a4-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file eth-hash-0.1.0a4.tar.gz.

File metadata

  • Download URL: eth-hash-0.1.0a4.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for eth-hash-0.1.0a4.tar.gz
Algorithm Hash digest
SHA256 8e3a8969f3c1212176aba75fb263c543ed16dd646a0543fda60e040b49e02ae1
MD5 3a1125737572332e12b17eb228ff08e3
BLAKE2b-256 a456011c4b2d3c9b43e21d4ea4b4eda2805eb3e18fc0e3dfbe8e0f16334ad1ba

See more details on using hashes here.

File details

Details for the file eth_hash-0.1.0a4-py3-none-any.whl.

File metadata

File hashes

Hashes for eth_hash-0.1.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 63f0935975f99216579495e8c8a8e8c57b4f8b442331d3fde67fe92b6898ff34
MD5 46a6c13399768ff96458927fe43ef91c
BLAKE2b-256 9e2a96ff26bd6ea7362a6aafa3dcbf0a9301914970a30e9df7caab0f0cbefa67

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