From 0b48920f94dda777befb3bd517f2dcd1129d4088 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Thu, 12 Jul 2018 15:25:48 -0700 Subject: [PATCH] Add README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5b51f6ed..445d7673 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,39 @@ -# Ethermint Skeleton +[![](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) -To build, execute these two commands: +# Ethermint -dep ensure +__**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 should it be used to hold any value. We will remove this warning when we have a release that is stable, secure, and properly tested. -go build main.go copied.go +### What is it? +`ethermint` will be an implementation of the EVM that runs on top of [`tendermint`](https://github.com/tendermint/tendermint) consensus, a Proof of Stake system. This project has as its primary goals: +- [Hard Spoon](https://blog.cosmos.network/introducing-the-hard-spoon-4a9288d3f0df) enablement: This is the ability to take a token from the Ethereum mainnet and "spoon" (shift) the balances over to another network. This feature is intended to make it easy for applications that require more transactions than the Ethereum main chain can provide to move their code over to a compatible chain with much more capacity. +- Web3 Compatibility: In order enable applications to be moved over to an ethermint chain existing tooling (i.e. web3 compatable clients) need to be able to interact with `ethermint`. + +### Implementation Steps + +- [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 + +### Building Ethermint + +To build, execute the following commands: + +```bash +# To build the binary and put the results in ./build +$ make get-tools get-vendor-deps build + +# To build the project and install it in $GOBIN +$ make get-tools get-vendor-deps install +``` + +### Community + +The following chat channels and forums are a great spot to ask questions about Ethermint: + +- [Cosmos Riot Chat Channel](https://riot.im/app/#/group/+cosmos:matrix.org) +- Cosmos Forum [![Discourse status](https://img.shields.io/discourse/https/forum.cosmos.network/status.svg)](https://forum.cosmos.network)