Skip to main content

eth-account: Sign Ethereum transactions and messages with local private keys

Project description

eth-account

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

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

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

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_account-0.13.1.tar.gz (7.5 MB view details)

Uploaded Source

Built Distribution

eth_account-0.13.1-py3-none-any.whl (352.5 kB view details)

Uploaded Python 3

File details

Details for the file eth_account-0.13.1.tar.gz.

File metadata

  • Download URL: eth_account-0.13.1.tar.gz
  • Upload date:
  • Size: 7.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.7

File hashes

Hashes for eth_account-0.13.1.tar.gz
Algorithm Hash digest
SHA256 a42a613481fda9d27e5e355f15e0ea24fd42ebdf01b0c074e399acddce5087a3
MD5 3e50f42b5fd097e750b2d1d391bff31e
BLAKE2b-256 776f8b61b16a7ccc9138cc1aa521f0b57bfbccf7996146a395e6ab363fa0b1ae

See more details on using hashes here.

File details

Details for the file eth_account-0.13.1-py3-none-any.whl.

File metadata

  • Download URL: eth_account-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 352.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.7

File hashes

Hashes for eth_account-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da864838a766345f25c66ead579b1077e3a5b8a825dd728055f341a13ee657d8
MD5 a8a2c80a1f0cd343dedef341a6627273
BLAKE2b-256 03769b2a093ceb90c3ea494099e1f1c065fef9f1a4af237b3f69fa57f4f30097

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