Skip to content

Commit 2ef3ec1

Browse files
committed
Cleanup introduction text
1 parent a31f304 commit 2ef3ec1

File tree

2 files changed

+44
-30
lines changed

2 files changed

+44
-30
lines changed

README.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,50 @@
1-
# Python Implementation of the EVM
1+
# Python Implementation of the Ethereum protocol
22

33
[![Join the chat at https://gitter.im/ethereum/py-evm](https://badges.gitter.im/ethereum/py-evm.svg)](https://gitter.im/ethereum/py-evm)
44
[![Documentation Status](https://readthedocs.org/projects/py-evm/badge/?version=latest)](http://py-evm.readthedocs.io/en/latest/?badge=latest)
55

66

7-
## Introducing Py-EVM
7+
## Py-EVM
88

9-
Py-EVM is a new implementation of the Ethereum Virtual Machine written in
10-
python. It is currently in active development but is quickly progressing
11-
through the test suite provided by ethereum/tests. We have Vitalik, and the
12-
existing PyEthereum code to thank for the quick progress we’ve made as many
13-
design decisions were inspired, or even directly ported from the PyEthereum
14-
codebase.
9+
Py-EVM is a new implementation of the Ethereum protocol in Python. It contains the low level
10+
primitives for the existing Ethereum 1.0 chain as well as emerging support for the upcoming
11+
Ethereum 2.0 / Serenity spec.
1512

1613
### Goals
1714

18-
Py-EVM aims to eventually become the defacto Python implementation of the EVM,
19-
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
20-
easy to digest documentation which can be run as a fully functional mainnet
21-
node.
15+
Py-EVM aims to eventually become the defacto Python implementation of the Ethereum protocol,
16+
enabling a wide array of use cases for both public and private chains.
2217

2318
In particular Py-EVM aims to:
2419

25-
- be an example implementation of the EVM in one of the most widely used and understood languages, Python.
26-
27-
- deliver the low level APIs for clients to build full or light nodes on top of
20+
- be a reference implementation of the Ethereum 1.0 and 2.0 implementation in one of the most widely used and understood languages, Python.
2821

2922
- be easy to understand and modifiable
3023

24+
- have clear and simple APIs
25+
26+
- come with solid, friendly documentation
27+
28+
- deliver the low level primitives to build various clients on top (including *full* and *light* clients)
29+
3130
- be highly flexible to support both research as well as alternate use cases like private chains.
3231

33-
### Trinity
32+
## Trinity
3433

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

37-
We provide a base implementation of a full node called Trinity that is based on Py-EVM.
37+
### Goals
3838

39-
In the future there may be alternative clients based on the Py-EVM.
39+
- provide a reference implementation for an Ethereum 1.0 node (alpha)
4040

41-
### Step 1: Alpha Release
41+
- support "full" and "light" modes
4242

43-
The plan is to begin with an MVP, alpha-level release that is suitable for
44-
testing purposes. We’ll be looking for early adopters to provide feedback on
45-
our architecture and API choices as well as general feedback and bug finding.
43+
- fully support mainnet as well as several testnets
4644

47-
#### Blog posts:
45+
- provide a reference implementation of an Ethereum 2.0 / Serenity beacon node (pre-alpha)
4846

49-
- https://medium.com/@pipermerriam/py-evm-part-1-origins-25d9ad390b
47+
- provide a reference implementation of an Ethereum 2.0 / Sereneity validator node (pre-alpha)
5048

5149

5250
## Quickstart

docs/introduction.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ If none of this makes sense to you yet we recommend to checkout the
1515
`higher level description <http://www.ethdocs.org/en/latest/introduction/what-is-ethereum.html>`_
1616
of the Ethereum project.
1717

18-
Goals
19-
-----
18+
Py-EVM goals
19+
------------
2020

21-
The main focus is to enrich the Ethereum ecosystem with a Python implementation that is:
21+
The main focus is to enrich the Ethereum ecosystem with a Python implementation that:
2222

23-
* Well documented
24-
* Easy to understand
23+
* Supports Ethereum 1.0 as well as 2.0 / Serenity
24+
* Is well documented
25+
* Is easy to understand
2526
* Has clear APIs
2627
* Runs fast and resource friendly
2728
* Is highly flexible to support:
@@ -31,6 +32,21 @@ The main focus is to enrich the Ethereum ecosystem with a Python implementation
3132
* Consortium chains
3233
* Advanced research
3334

35+
Trinity goals
36+
-------------
37+
38+
While Py-EVM provides the low level APIs of the Ethereum protocol, it does not aim to implement a
39+
full or light node directly.
40+
41+
Trinity is a refernece implementation on top of Py-EVM that aims to:
42+
43+
* Provide a reference implementation for an Ethereum 1.0 node (alpha)
44+
* Support "full" and "light" modes
45+
* Fully support mainnet as well as several testnets
46+
* Provide a reference implementation of an Ethereum 2.0 / Serenity beacon node (pre-alpha)
47+
* Provide a reference implementation of an Ethereum 2.0 / Sereneity validator node (pre-alpha)
48+
49+
3450
.. note::
3551

3652
Trinity is currently in **public alpha** and can connect and sync to the main ethereum network.

0 commit comments

Comments
 (0)