eth-account

Sign Ethereum transactions and messages with local private keys

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

Quickstart

python -m pip install eth-account

Developer Setup

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

To run the integration test cases, you need to install node and the custom cli tool as follows:

apt-get install -y nodejs  # As sudo
./tests/integration/js-scripts/setup_node_v20.sh  # As sudo
cd tests/integration/js-scripts
npm install -g .  # As sudo

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 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"