docs: vuepress setup and section titles (#311)

* vuepress * docs: vuepress setup and TODOs * doc scripts * update Makefile and gitignore * more docs updates * gitignore * metamask instructions * update image * updates * updates from call * docs: vuepress config and home.vue (#350) * update uncles return (#337) * x/evm: fix EndBlock consensus failure (#334) * add test for sending tx w/ 21000 gas * improve rpc transfer test * use ctx in EndBlock * UpdateAccounts and ClearStateObjects with passed in context * log ethereum address on error Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze <federico.kunze94@gmail.com> * update Ethermint color variables * add header and footer logo * tweak config.js * WIP custom homepage.vue * add layout to docs/README * update color variables * add eth logo black and white * tweak docs/README * update logo and logo-bw svg * bump 1.0.167 * homepage → home * add icon-code, icon-rocket * layout: home, remove configurable frontmatter: label, read, use * clean up config.js * bump 1.0.168 * fix missing comma from resolving conflicts * update sidebar, config nav, path * remove left whitespace on the header and footer logos * clean up home.vue, docs/README * update ethermint forum url in footer.links * comment out custom true to enable searchbar in subpages * remove external link icon for Guides * comments, revert custom true * clean up config.js, add specifications icon Co-authored-by: noot <36753753+noot@users.noreply.github.com> Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze <federico.kunze94@gmail.com> * final touches Co-authored-by: Cyrus Goh <hello@lovincyrus.com> Co-authored-by: noot <36753753+noot@users.noreply.github.com>
2020-07-02 04:22:45 -04:00
parent edf4357176
commit d4fe9b234c
36 changed files with 12230 additions and 105 deletions
@@ -1,50 +1,18 @@
+<!--
+order: false
+parent:
+  order: 1
+-->
+
 # Introduction

-## What is Ethermint
+This folder contains introduction material for 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.
+1. [Overview](./overview.md)
+1. [Architecture](./architecture.md)

-Here’s a glance at some of the key features of Ethermint:
+After reading the introduction material, head over to the [basics](../basics/README.md) to learn more.

-* Web3 compatibility
-* High throughput
-* Horizontal scalability
-* Transaction finality
+## Next {hide}

-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)
-
-Tendermint consists of two chief technical components: a blockchain consensus
-engine and a generic application interface. The consensus engine, called
-Tendermint Core, ensures that the same transactions are recorded on every machine
-in the same order. The application interface, called the Application Blockchain
-Interface (ABCI), enables the transactions to be processed in any programming
-language.
-
-Tendermint has evolved to be a general purpose blockchain consensus engine that
-can host arbitrary application states. Since Tendermint can replicate arbitrary
-applications, it can be used as a plug-and-play replacement for the consensus
-engines of other blockchains. Ethermint is such an example of an ABCI application
-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.
+Get an high-level [overview](./overview.md) of Ethermint {hide}
@@ -0,0 +1,38 @@
+<!--
+order: 2
+-->
+
+# Architecture
+
+Learn how Ethermint's architecture leverages the Cosmos SDK Proof-of-Stake functionallity, EVM compatibility and fast-finality from Tendermint Core's BFT consensus. {synopsis}
+
+## Cosmos-SDK
+
+<!-- TODO: -->
+
+## Tendermint Core & the Application Blockchain Interface (ABCI)
+
+Tendermint consists of two chief technical components: a blockchain consensus
+engine and a generic application interface. The consensus engine, called
+Tendermint Core, ensures that the same transactions are recorded on every machine
+in the same order. The application interface, called the Application Blockchain
+Interface (ABCI), enables the transactions to be processed in any programming
+language.
+
+Tendermint has evolved to be a general purpose blockchain consensus engine that
+can host arbitrary application states. Since Tendermint can replicate arbitrary
+applications, it can be used as a plug-and-play replacement for the consensus
+engines of other blockchains. Ethermint is such an example of an ABCI application
+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.
+
+## EVM module
+
+<!-- TODO: -->
+
+## Next {hide}
+
+Learn how to run an Ethermint [node](./../quickstart/run_node.md) {hide}
@@ -0,0 +1,37 @@
+<!--
+order: 1
+-->
+
+# High-level Overview
+
+## 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!
+
+## Next {hide}
+
+Learn about Ethermint's [architecture](./architectures.md) {hide}