Skip to main content

eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding

Project description

Ethereum Contract Interface (ABI) Utility

Join the chat at https://gitter.im/ethereum/eth-abi Build Status PyPI version Python versions Docs build

Python utilities for working with Ethereum ABI definitions, especially encoding and decoding

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

Quickstart

pip install eth_abi

Developer Setup

If you would like to hack on eth-abi, please check out the Snake Charmers 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-abi.git
cd eth-abi
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_abi/ tests/ -c "clear; flake8 eth_abi 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-abi failed'" ../tests ../eth_abi

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. This is typically done from the master branch, except when releasing a beta (in which case the beta is released from master, 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_abi-4.0.0b2.tar.gz (484.6 kB view details)

Uploaded Source

Built Distribution

eth_abi-4.0.0b2-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

Details for the file eth_abi-4.0.0b2.tar.gz.

File metadata

  • Download URL: eth_abi-4.0.0b2.tar.gz
  • Upload date:
  • Size: 484.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for eth_abi-4.0.0b2.tar.gz
Algorithm Hash digest
SHA256 0cbd5a854acf101843d3f009b10a8b63050125981211ea4d074a80eb953f97ab
MD5 9a10088e57d127ea8072369c2c9c4d20
BLAKE2b-256 ce3bed5da5ec9a47b1d6f99b10f606887ee2340ea1bc06ea1b0cef53f2fa8d64

See more details on using hashes here.

File details

Details for the file eth_abi-4.0.0b2-py3-none-any.whl.

File metadata

  • Download URL: eth_abi-4.0.0b2-py3-none-any.whl
  • Upload date:
  • Size: 28.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for eth_abi-4.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 9c81da53b0b48f72c539eb5744b7596ccb97e626e585eb4f1354b1670ea51ae2
MD5 c706618eeb5512bde7e7da178f0ba2a2
BLAKE2b-256 1d8c59134d5f6e142004cce7863343313cf6fde959b2726de936f8a5718933c9

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