Skip to main content

eth-utils: Common utility functions for python code that interacts with Ethereum

Project description

Ethereum Utilities

Join the conversation on Discord Build Status PyPI version Python versions Docs build

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 git@github.com: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"

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_utils-5.3.0.tar.gz (123.8 kB view details)

Uploaded Source

Built Distribution

eth_utils-5.3.0-py3-none-any.whl (102.5 kB view details)

Uploaded Python 3

File details

Details for the file eth_utils-5.3.0.tar.gz.

File metadata

  • Download URL: eth_utils-5.3.0.tar.gz
  • Upload date:
  • Size: 123.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for eth_utils-5.3.0.tar.gz
Algorithm Hash digest
SHA256 1f096867ac6be895f456fa3acb26e9573ae66e753abad9208f316d24d6178156
MD5 4cbe0f14968ebd1e1a53d2fe314d30c3
BLAKE2b-256 0d49bee95f16d2ef068097afeeffbd6c67738107001ee57ad7bcdd4fc4d3c6a7

See more details on using hashes here.

File details

Details for the file eth_utils-5.3.0-py3-none-any.whl.

File metadata

  • Download URL: eth_utils-5.3.0-py3-none-any.whl
  • Upload date:
  • Size: 102.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for eth_utils-5.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac184883ab299d923428bbe25dae5e356979a3993e0ef695a864db0a20bc262d
MD5 9b27f8d95f80b4ce6a7ca16b7ad58cf9
BLAKE2b-256 c4c60417a92e6a3fc9b85f5a8380d9f9d43b69ba836a90e45f79f9ae74d41e53

See more details on using hashes here.

Supported by

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