Skip to main content

eth-typing

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

Common type annotations for ethereum python packages.

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

Quickstart

python -m pip install eth-typing

Developer Setup

If you would like to hack on eth-typing, 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-typing.git
cd eth-typing
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install

Network ChainIds

A list of ChainId constants reside in the eth-typing/networks.py file. This list should be kept in sync with the network list available on chainid.network.

To keep the list up to date, run the following command:

python update_network_chain_ids.py

This will remove the original networks file and output a new file with the new networks added.

Check that the output file is correct and that constants are defined as expected. If the shortName contains special characters it may not work as a constant variable name. The script should be updated to transform names into valid constants as new cases occur.

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"

Metadata

Release files for eth-typing 4.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eth-typing 4.1.0
File Size Uploaded
eth-typing-4.1.0.tar.gz 17.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for eth-typing 4.1.0
File Interpreter ABI Platform
eth_typing-4.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.6 kB

Release files / eth-typing-4.1.0.tar.gz

Download URL eth-typing-4.1.0.tar.gz
Size 17.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ed52b0c6b049240fd810bc87c8857c7ea39370f060f70b9ca3876285269f2938
BLAKE2b-256 checksum
How to use checksums
6e2df6e4d2992dc1120914c3c55601b4c0fff7eff72f5257dd891d30d07d45ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release files / eth_typing-4.1.0-py3-none-any.whl

Download URL eth_typing-4.1.0-py3-none-any.whl
Size 14.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f1b16bf37bfe0be730731fd24c7398e931a2b45a8feebf82df2e77a611a23be
BLAKE2b-256 checksum
How to use checksums
65f6137782f26d63f3a8072f30513fafe41388d2132934f4f90bc673d77fdc1f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page