README
¶
Subnet EVM
Odyssey is a network composed of multiple blockchains. Each blockchain is an instance of a Virtual Machine (VM), much like an object in an object-oriented language is an instance of a class. That is, the VM defines the behavior of the blockchain.
Subnet EVM is the Virtual Machine (VM) that defines the Subnet Contract Chains. Subnet EVM is a simplified version of Coreth VM (D-Chain).
This chain implements the Ethereum Virtual Machine and supports Solidity smart contracts as well as most other Ethereum client functionality.
Building
The Subnet EVM runs in a separate process from the main OdysseyGo process and communicates with it over a local gRPC connection.
OdysseyGo Compatibility
[v0.0.1] OdysseyGo@v0.0.1 (Protocol Version: 28)
API
The Subnet EVM supports the following API namespaces:
ethpersonaltxpooldebug
Only the eth namespace is enabled by default.
Compatibility
The Subnet EVM is compatible with almost all Ethereum tooling, including Remix, Metamask and Truffle.
Differences Between Subnet EVM and Coreth
- Added configurable fees and gas limits in genesis
- Merged Odyssey hardforks into the single "Subnet EVM" hardfork
- Removed Atomic Txs and Shared Memory
- Removed Multicoin Contract and State
Block Format
To support these changes, there have been a number of changes to the SubnetEVM block format compared to what exists on the D-Chain and Ethereum. Here we list the changes to the block format as compared to Ethereum.
Block Header
BaseFee: Added by EIP-1559 to represent the base fee of the block (present in Ethereum as of EIP-1559)BlockGasCost: surcharge for producing a block faster than the target rate
Create an EVM Subnet on a Local Network
Clone Subnet-evm
First install Go 1.20.8 or later. Follow the instructions here. You can verify by running go version.
Set $GOPATH environment variable properly for Go to look for Go Workspaces. Please read this for details. You can verify by running echo $GOPATH.
As a few software will be installed into $GOPATH/bin, please make sure that $GOPATH/bin is in your $PATH, otherwise, you may get error running the commands below.
Download the subnet-evm repository into your $GOPATH:
cd $GOPATH
mkdir -p src/github.com/DioneProtocol
cd src/github.com/DioneProtocol
git clone git@github.com:DioneProtocol/subnet-evm.git
cd subnet-evm
This will clone and checkout to master branch.
Run Local Network
To run a local network, it is recommended to use the odyssey-cli to set up an instance of Subnet-EVM on an local Odyssey Network.
There are two options when using the Odyssey-CLI:
- Use an official Subnet-EVM release.
- Build and deploy a locally built (and optionally modified) version of Subnet-EVM.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package accounts implements high level Ethereum account management.
|
Package accounts implements high level Ethereum account management. |
|
abi
Package abi implements the Ethereum ABI (Application Binary Interface).
|
Package abi implements the Ethereum ABI (Application Binary Interface). |
|
abi/bind
Package bind generates Ethereum contract Go bindings.
|
Package bind generates Ethereum contract Go bindings. |
|
abi/bind/precompilebind
Package bind generates Ethereum contract Go bindings.
|
Package bind generates Ethereum contract Go bindings. |
|
keystore
Package keystore implements encrypted storage of secp256k1 private keys.
|
Package keystore implements encrypted storage of secp256k1 private keys. |
|
cmd
|
|
|
abigen
command
(c) 2023, Ava Labs, Inc.
|
(c) 2023, Ava Labs, Inc. |
|
evm
command
evm executes EVM code snippets.
|
evm executes EVM code snippets. |
|
precompilegen
command
|
|
|
simulator/main
command
|
|
|
Package consensus implements different Ethereum consensus engines.
|
Package consensus implements different Ethereum consensus engines. |
|
Package core implements the Ethereum consensus protocol.
|
Package core implements the Ethereum consensus protocol. |
|
bloombits
Package bloombits implements bloom filtering on batches of data.
|
Package bloombits implements bloom filtering on batches of data. |
|
rawdb
Package rawdb contains a collection of low level database accessors.
|
Package rawdb contains a collection of low level database accessors. |
|
state
Package state provides a caching layer atop the Ethereum state trie.
|
Package state provides a caching layer atop the Ethereum state trie. |
|
state/snapshot
Package snapshot implements a journalled, dynamic state dump.
|
Package snapshot implements a journalled, dynamic state dump. |
|
types
Package types contains data types related to Ethereum consensus.
|
Package types contains data types related to Ethereum consensus. |
|
vm
Package vm implements the Ethereum Virtual Machine.
|
Package vm implements the Ethereum Virtual Machine. |
|
vm/runtime
Package runtime provides a basic execution model for executing EVM code.
|
Package runtime provides a basic execution model for executing EVM code. |
|
Package eth implements the Ethereum protocol.
|
Package eth implements the Ethereum protocol. |
|
filters
Package filters implements an ethereum filtering system for block, transactions and log events.
|
Package filters implements an ethereum filtering system for block, transactions and log events. |
|
tracers
Package tracers is a manager for transaction tracing engines.
|
Package tracers is a manager for transaction tracing engines. |
|
tracers/internal/tracetest
(c) 2023, Ava Labs, Inc.
|
(c) 2023, Ava Labs, Inc. |
|
tracers/js/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
|
Package tracers contains the actual JavaScript tracer assets. |
|
Package ethclient provides a client for the Ethereum RPC API.
|
Package ethclient provides a client for the Ethereum RPC API. |
|
subnetevmclient
Package subnetevmclient provides an RPC client for subnet-evm-specific APIs.
|
Package subnetevmclient provides an RPC client for subnet-evm-specific APIs. |
|
Package ethdb defines the interfaces for an Ethereum data store.
|
Package ethdb defines the interfaces for an Ethereum data store. |
|
leveldb
Package leveldb implements the key-value database layer based on LevelDB.
|
Package leveldb implements the key-value database layer based on LevelDB. |
|
memorydb
Package memorydb implements the key-value database layer based on memory maps.
|
Package memorydb implements the key-value database layer based on memory maps. |
|
pebble
Package pebble implements the key-value database layer based on pebble.
|
Package pebble implements the key-value database layer based on pebble. |
|
Package ethereum defines interfaces for interacting with Ethereum.
|
Package ethereum defines interfaces for interacting with Ethereum. |
|
internal
|
|
|
debug
Package debug interfaces Go runtime debugging facilities.
|
Package debug interfaces Go runtime debugging facilities. |
|
ethapi
Package ethapi implements the general Ethereum API functions.
|
Package ethapi implements the general Ethereum API functions. |
|
version
Package version implements reading of build version information.
|
Package version implements reading of build version information. |
|
Go port of Coda Hale's Metrics library
|
Go port of Coda Hale's Metrics library |
|
Package miner implements Ethereum block creation and mining.
|
Package miner implements Ethereum block creation and mining. |
|
precompile
|
|
|
contract
Defines the interface for the configuration and execution of a precompile contract
|
Defines the interface for the configuration and execution of a precompile contract |
|
precompileconfig
Defines the stateless interface for unmarshalling an arbitrary config of a precompile
|
Defines the stateless interface for unmarshalling an arbitrary config of a precompile |
|
registry
Module to facilitate the registration of precompiles and their configuration.
|
Module to facilitate the registration of precompiles and their configuration. |
|
Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
|
Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports. |
|
signer
|
|
|
sync
|
|
|
precompile/solidity
Implements solidity tests.
|
Implements solidity tests. |
|
Package trie implements Merkle Patricia Tries.
|
Package trie implements Merkle Patricia Tries. |
|
x
|
|