pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-30 15:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Write pallet_evm README (#7487)

Browse Source 
* describe pallet evm

* add license

* write readme into lib.rs

* change some sentence

Co-authored-by: Wei Tang <accounts@that.world>

* update implementation status

Co-authored-by: Wei Tang <accounts@that.world>

* update readme according to review

* Update frame/evm/src/lib.rs

* fix line length

Co-authored-by: Wei Tang <accounts@that.world>
Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Shinsaku Ashizawa
2020-11-09 02:18:34 +09:00
committed by GitHub
parent 6ded31477d
commit e41e44a3b4
2 changed files with 61 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/evm/README.md
+27 -1
View File
@@ -1,3 +1,29 @@
EVM execution module for Substrate
# EVM Module
The EVM module allows unmodified EVM code to be executed in a Substrate-based blockchain.
- [`evm::Trait`](https://docs.rs/pallet-evm/2.0.0/pallet_evm/trait.Trait.html)
## EVM Engine
The EVM module uses [`SputnikVM`](https://github.com/rust-blockchain/evm) as the underlying EVM engine. The engine is overhauled so that it's [`modular`](https://github.com/corepaper/evm).
## Execution Lifecycle
There are a separate set of accounts managed by the EVM module. Substrate based accounts can call the EVM Module to deposit or withdraw balance from the Substrate base-currency into a different balance managed and used by the EVM module. Once a user has populated their balance, they can create and call smart contracts using this module.
There's one-to-one mapping from Substrate accounts and EVM external accounts that is defined by a conversion function.
## EVM Module vs Ethereum Network
The EVM module should be able to produce nearly identical results compared to the Ethereum mainnet, including gas cost and balance changes.
Observable differences include:
- The available length of block hashes may not be 256 depending on the configuration of the System module in the Substrate runtime.
- Difficulty and coinbase, which do not make sense in this module and is currently hard coded to zero.
We currently do not aim to make unobservable behaviors, such as state root, to be the same. We also don't aim to follow the exact same transaction / receipt format. However, given one Ethereum transaction and one Substrate account's private key, one should be able to convert any Ethereum transaction into a transaction compatible with this module.
The gas configurations are configurable. Right now, a pre-defined Istanbul hard fork configuration option is provided.
License: Apache-2.0
substrate/frame/evm/src/lib.rs
+34 -1
View File
@@ -15,7 +15,40 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! EVM execution module for Substrate
//! # EVM Module
//!
//! The EVM module allows unmodified EVM code to be executed in a Substrate-based blockchain.
//! - [`evm::Trait`]
//!
//! ## EVM Engine
//!
//! The EVM module uses [`SputnikVM`](https://github.com/rust-blockchain/evm) as the underlying EVM engine.
//! The engine is overhauled so that it's [`modular`](https://github.com/corepaper/evm).
//!
//! ## Execution Lifecycle
//!
//! There are a separate set of accounts managed by the EVM module. Substrate based accounts can call the EVM Module
//! to deposit or withdraw balance from the Substrate base-currency into a different balance managed and used by
//! the EVM module. Once a user has populated their balance, they can create and call smart contracts using this module.
//!
//! There's one-to-one mapping from Substrate accounts and EVM external accounts that is defined by a conversion function.
//!
//! ## EVM Module vs Ethereum Network
//!
//! The EVM module should be able to produce nearly identical results compared to the Ethereum mainnet,
//! including gas cost and balance changes.
//!
//! Observable differences include:
//!
//! - The available length of block hashes may not be 256 depending on the configuration of the System module
//! in the Substrate runtime.
//! - Difficulty and coinbase, which do not make sense in this module and is currently hard coded to zero.
//!
//! We currently do not aim to make unobservable behaviors, such as state root, to be the same. We also don't aim to follow
//! the exact same transaction / receipt format. However, given one Ethereum transaction and one Substrate account's
//! private key, one should be able to convert any Ethereum transaction into a transaction compatible with this module.
//!
//! The gas configurations are configurable. Right now, a pre-defined Istanbul hard fork configuration option is provided.
// Ensure we're `no_std` when compiling for Wasm.
#![cfg_attr(not(feature = "std"), no_std)]