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.0.tar.gz (717.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: eth_abi-4.0.0.tar.gz
  • Upload date:
  • Size: 717.4 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.0.tar.gz
Algorithm Hash digest
SHA256 6949baba61a2c453f0719309ca145e8876a1cbae7ba377c991e67240c13ec7fc
MD5 b54fb33c4590114153fdb92fcdf7b777
BLAKE2b-256 f72a13370581fbafc40cf4aaa6ce18d587047ead579c6095b360adc3dbb028cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eth_abi-4.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79d258669f3505319e53638d644a75e1c816db552a1ab1927c3063763cc41031
MD5 a7043ed3cbd7e0bab9137a3b800fb48a
BLAKE2b-256 12da73c19cbc0166dce978c79ee69334ea4a009fc3b4bc7b21fb5818691a851d

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