Skip to main content

Python implementation of the Ethereum Virtual Machine

Project description

Join the chat at https://gitter.im/ethereum/py-evm Documentation Status

Documentation hosted by ReadTheDocs

Introducing Py-EVM

Py-EVM is a new implementation of the Ethereum Virtual Machine written in python. It is currently in active development but is quickly progressing through the test suite provided by ethereum/tests. We have Vitalik, and the existing PyEthereum code to thank for the quick progress we’ve made as many design decisions were inspired, or even directly ported from the PyEthereum codebase.

Goals

Py-EVM aims to eventually become the defacto Python implementation of the EVM, enabling a wide array of use cases for both public and private chains. Development will focus on creating an EVM with a well defined API, friendly and easy to digest documentation which can be run as a fully functional mainnet node.

In particular Py-EVM aims to:

  • be an example implementation of the EVM in one of the most widely used and understood languages, Python.

  • deliver the low level APIs for clients to build full or light nodes on top of

  • be easy to understand and modifiable

  • be highly flexible to support both research as well as alternate use cases like private chains.

Trinity

While Py-EVM provides the low level APIs of the EVM, it does not aim to implement a full or light node directly.

We provide a base implementation of a full node called Trinity that is based on Py-EVM.

In the future there may be alternative clients based on the Py-EVM.

Step 1: Alpha Release

The plan is to begin with an MVP, alpha-level release that is suitable for testing purposes. We’ll be looking for early adopters to provide feedback on our architecture and API choices as well as general feedback and bug finding.

Blog posts:

Development

Py-EVM depends on a submodule of the common tests across all clients, so you need to clone the repo with the --recursive flag. Example:

git clone --recursive git@github.com:ethereum/py-evm.git

Then install the required python packages via:

pip install -e . -r requirements-dev.txt

Running the tests

You can run the tests with:

py.test tests

Or you can install tox to run the full test suite.

Releasing

Pandoc is required for transforming the markdown README to the proper format to render correctly on pypi.

For Debian-like systems:

apt install pandoc

Or on OSX:

brew install pandoc

To release a new version:

bumpversion $$VERSION_PART_TO_BUMP$$
git push && git push --tags
make release

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, use bumpversion and specify which part to bump, like bumpversion minor or bumpversion devnum.

If you are in a beta version, bumpversion stage will switch to a stable.

To issue an unstable version when the current version is stable, specify the new version explicitly, like bumpversion --new-version 4.0.0-alpha.1 devnum

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-evm-0.2.0a12.tar.gz (156.2 kB view details)

Uploaded Source

Built Distribution

py_evm-0.2.0a12-py3-none-any.whl (218.5 kB view details)

Uploaded Python 3

File details

Details for the file py-evm-0.2.0a12.tar.gz.

File metadata

  • Download URL: py-evm-0.2.0a12.tar.gz
  • Upload date:
  • Size: 156.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for py-evm-0.2.0a12.tar.gz
Algorithm Hash digest
SHA256 96877163b9d0acbd9828028a6ea603cd6ec00581b05c6639d438491f4070865c
MD5 7008a61680c9e04da18839eef34b1711
BLAKE2b-256 e1706b0e1d0c3f12e46ed8cae8e036a193ae5a8c1b084c8025eb76513935adc6

See more details on using hashes here.

File details

Details for the file py_evm-0.2.0a12-py3-none-any.whl.

File metadata

File hashes

Hashes for py_evm-0.2.0a12-py3-none-any.whl
Algorithm Hash digest
SHA256 cfe0d7f6c8362e34134040432dba1ae93730bf23c62d70620f1aefd7f016d3fe
MD5 4cc3bbde3110c17fb5e513c4582cc263
BLAKE2b-256 d54443ee045613e3a00c9685b2a97ddf86424e53bb89e873dc160de519d2a4da

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