eth-utils5.3.0
Published
eth-utils: Common utility functions for python code that interacts with Ethereum
pip install eth-utils
Package Downloads
Authors
Project URLs
Requires Python
<4,>=3.8
Dependencies
- eth-hash
>=0.3.1 - eth-typing
>=5.0.0 - toolz
>0.8.2; implementation_name == "pypy" - cytoolz
>=0.10.1; implementation_name == "cpython" - pydantic
<3,>=2.0.0 - build
>=0.9.0; extra == "dev" - bump_my_version
>=0.19.0; extra == "dev" - eth-hash
[pycryptodome]; extra == "dev" - ipython
; extra == "dev" - mypy
==1.10.0; extra == "dev" - pre-commit
>=3.4.0; extra == "dev" - tox
>=4.0.0; extra == "dev" - twine
; extra == "dev" - wheel
; extra == "dev" - sphinx
>=6.0.0; extra == "dev" - sphinx-autobuild
>=2021.3.14; extra == "dev" - sphinx_rtd_theme
>=1.0.0; extra == "dev" - towncrier
<25,>=24; extra == "dev" - hypothesis
>=4.43.0; extra == "dev" - mypy
==1.10.0; extra == "dev" - pytest
>=7.0.0; extra == "dev" - pytest-xdist
>=2.4.0; extra == "dev" - sphinx
>=6.0.0; extra == "docs" - sphinx-autobuild
>=2021.3.14; extra == "docs" - sphinx_rtd_theme
>=1.0.0; extra == "docs" - towncrier
<25,>=24; extra == "docs" - hypothesis
>=4.43.0; extra == "test" - mypy
==1.10.0; extra == "test" - pytest
>=7.0.0; extra == "test" - pytest-xdist
>=2.4.0; extra == "test"
Ethereum Utilities
Common utility functions for python code that interacts with Ethereum
Read the documentation.
View the change log.
Installation
python -m pip install eth-utils
Developer Setup
If you would like to hack on eth-utils, please check out the Snake Charmers Tactical Manual for information on how we do:
- Testing
- Pull Requests
- Documentation
We use pre-commit 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:
git clone [email protected]:ethereum/eth-utils.git
cd eth-utils
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
Update Networks
The list of networks resides in the JSON file under eth_utils/__json/eth_networks.json. This file is used to initialize Networks, which can be used to obtain network information with a chain ID.
Run the script to update the JSON file with the response from the remote list.
python update_networks.py
If there are new networks they will appear in the JSON file. After checking the updates, open a PR to make them available in a new release.
Release setup
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. 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"