Skip to content
/ eth-abi Public
forked from ethereum/eth-abi

Ethereum ABI utilities for python

License

Notifications You must be signed in to change notification settings

pacrob/eth-abi

 
 

Repository files navigation

Ethereum Contract Interface (ABI) Utility

Join the conversation on Discord 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

python -m 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
  • 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-abi.git
cd eth-abi
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install

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"

About

Ethereum ABI utilities for python

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.3%
  • Makefile 1.4%
  • Shell 0.3%