Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

evm: module specification #538

Merged
merged 25 commits into from
Dec 9, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
evm: module specification
  • Loading branch information
fedekunze committed Sep 23, 2020
commit cfa45785c0ee37a6e5db75b770cd340bfc2507a5
5 changes: 5 additions & 0 deletions x/evm/spec/01_concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 1
-->

# Concepts
5 changes: 5 additions & 0 deletions x/evm/spec/02_state.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 1
-->

# State
5 changes: 5 additions & 0 deletions x/evm/spec/03_state_transitions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 3
-->

# State Transitions
5 changes: 5 additions & 0 deletions x/evm/spec/04_messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 4
-->

# Messages
5 changes: 5 additions & 0 deletions x/evm/spec/05_abci.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 5
-->

# ABCI
5 changes: 5 additions & 0 deletions x/evm/spec/06_events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 6
-->

# Events
5 changes: 5 additions & 0 deletions x/evm/spec/07_paramaters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
order: 7
-->

# Parameters
43 changes: 40 additions & 3 deletions x/evm/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,45 @@ parent:

## Abstract

<!-- TODO: -->
This document defines the specification of the Ethereum Virtual Machine (EVM) as a Cosmos SDK module.

## Content
## Contents

<!-- TODO: -->
1. **[Concepts](01_concepts.md)**
2. **[State](02_state.md)**
3. **[State Transitions](03_state_transitions.md)**
4. **[Messages](04_messages.md)**
5. **[ABCI](05_abci.md)**
6. **[Events](06_events.md)**
7. **[Parameters](07_params.md)**

## Module Architecture

> **NOTE for auditors**: If you're not familiar with the overall module structure from
the SDK modules, please check this [document](https://docs.cosmos.network/master/building-modules/structure.html) as
prerequisite reading.

```shell
evm/
├── client
│ └── cli
│ ├── query.go
│    └── tx.go
├── keeper
│ ├── keeper.go
│ └── querier.go
├── types
│   ├── chain_config.go
│   ├── codec.go # Type registration for encoding
│   ├── errors.go # Module-specific errors
│   ├── events.go # Events exposed to the Tendermint PubSub/Websocket
│   ├── genesis.go # Genesis state for the module
│   ├── journal.go # Ethereum Journal of state transitions
│   ├── msg.go # EVM module transaction messages
│   ├── params.go # Module parameters that can be customized with governance parameter change proposals
│   ├── keys.go # Store keys and utility functions
│   └── tx_data.go # Ethereum transaction data types
├── abci.go # ABCI BeginBlock and EndBlock logic
├── handler.go # Message routing
└── module.go # Module setup for the module manager
```