From 94b84b484c2fcbb42daf99b209c710c227ea9538 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Mon, 20 Aug 2018 19:21:02 -0700 Subject: [PATCH 1/2] Change copy in intro/README --- docs/intro/README.md | 54 ++++++++++++++++++++++++-------------------- 1 file changed, 29 insertions(+), 25 deletions(-) diff --git a/docs/intro/README.md b/docs/intro/README.md index 0fac0cee..61ef3acb 100644 --- a/docs/intro/README.md +++ b/docs/intro/README.md @@ -1,6 +1,34 @@ # Introduction -## Preliminary +## What is Ethermint + +Ethermint is a high throughput PoS blockchain that is fully compatible and +interoperable with Ethereum. In other words, it allows for running vanilla Ethereum +on top of [Tendermint](https://github.com/tendermint/tendermint) consensus via +the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/). This allows developers +to have all the desired features of Ethereum, while at the same time benefit +from Tendermint’s PoS implementation. Also, because it is built on top of the +Cosmos SDK, it will be able to exchange value with the rest of the Cosmos Ecosystem. + +Here’s a glance at some of the key features of Ethermint: + +* Web3 compatibility +* High throughput +* Horizontal scalability +* Transaction finality + +Ethermint enables these key features through: + +* Implementing Tendermint's ABCI application interface to manage the base Blockchain +* Leveraging [modules](https://github.com/cosmos/cosmos-sdk/tree/master/x/) and other mechanisms implemented by the Cosmos SDK +* Utilizing [`geth`](https://github.com/ethereum/go-ethereum) as a library to avoid code reuse and improve maintainability +* Exposing a fully compatible Web3 RPC layer for interacting with the system + +The sum of these features allows developers to leverage existing Ethereum ecosystem +tooling and software to seamlessly deploy smart contracts which interact with the rest of the Cosmos +ecosystem! + +## In-depth Topics ### Tendermint Core & the Application Blockchain Interface (ABCI) @@ -20,27 +48,3 @@ replacing Ethereum's PoW via Tendermint's consensus engine. Another example of a cryptocurrency application built on Tendermint is the Cosmos network. Tendermint is able to decompose the blockchain design by offering a very simple API (ie. the ABCI) between the application process and consensus process. - -## What is Ethermint - -Ethermint is a high throughput PoS blockchain that is fully compatible and -interoperable with Ethereum. In other words, it allows for running vanilla Ethereum -on top of [Tendermint](https://github.com/tendermint/tendermint) consensus via -the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/). This allows developers -to have all the desired features of Ethereum, while at the same time benefit -from Tendermint’s PoS implementation. - -Here’s a glance at some of the key features of Ethermint: - -* Web3 compatibility -* High throughput -* Horizontal scalability -* Transaction finality - -Ethermint achieves these key features by implementing Tendermint's ABCI application -interface, leveraging modules and mechanisms implemented by the Cosmos SDK, utilizing -[Geth](https://github.com/ethereum/go-ethereum) as a library by implementing all -necessary interfaces, and finally by exposing a fully compatible Web3 RPC layer -allowing developers to leverage existing Ethereum ecosystem tooling and software -to seamlessly deploy smart contracts and interact with the rest of the Cosmos -ecosystem! From 712d1d7c34b2c10e272c1fc685dd237edb616002 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Tue, 21 Aug 2018 15:22:50 -0700 Subject: [PATCH 2/2] Update README --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 854683bd..25731bd0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[![](https://godoc.org/github.com/cosmos/ethermint?status.svg)](http://godoc.org/github.com/cosmos/ethermint) [![Go Report Card](https://goreportcard.com/badge/github.com/cosmos/ethermint)](https://goreportcard.com/report/github.com/cosmos/ethermint) [![CircleCI](https://circleci.com/gh/cosmos/ethermint.svg?style=svg)](https://circleci.com/gh/cosmos/ethermint) - +[![CircleCI](https://circleci.com/gh/cosmos/ethermint.svg?style=svg)](https://circleci.com/gh/cosmos/ethermint) +[![](https://godoc.org/github.com/cosmos/ethermint?status.svg)](http://godoc.org/github.com/cosmos/ethermint) [![Go Report Card](https://goreportcard.com/badge/github.com/cosmos/ethermint)](https://goreportcard.com/report/github.com/cosmos/ethermint) # Ethermint __**WARNING:**__ Ethermint is under VERY ACTIVE DEVELOPMENT and should be treated as pre-alpha software. This means it is not meant to be run in production, its APIs are subject to change without warning and should not be relied upon, and it should not be used to hold any value. We will remove this warning when we have a release that is stable, secure, and properly tested. @@ -13,18 +13,26 @@ __**WARNING:**__ Ethermint is under VERY ACTIVE DEVELOPMENT and should be treate ### Implementation -- [x] Have a working implementation that can parse and validate the existing ETH Chain and persist it in a Tendermint store -- [ ] Benchmark this implementation to ensure performance -- [ ] Allow the Ethermint EVM to interact with other [Cosmos SDK modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/app3.md) -- [ ] Implement the Web3 APIs as a Cosmos Light Client for Ethermint -- [ ] Ethermint is a full Cosmos SDK application and can be deployed as it's own zone +#### Completed +- Have a working implementation that can parse and validate the existing ETH Chain and persist it in a Tendermint store +- Implement Ethereum transactions in the CosmosSDK + +#### Current Work +- Implement web3 compatible API layer +- Implement the EVM as a CosmosSDK module +- Allow the Ethermint EVM to interact with other [Cosmos SDK modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/app3.md) + +#### Next Steps +- Hard spoon enablement: The ability to export state from `geth` and import token balances into Ethermint +- Ethermint is a functioning Cosmos SDK application and can be deployed as its own zone +- Full web3 compatibility will enable existing Ethereum applications to use Ethermint ### Building Ethermint To build, execute the following commands: ```bash -# To build the binary and put the results in ./build +# To build the binary and put the resulting binary in ./build $ make tools deps build # To build the project and install it in $GOBIN