EVMC

[![chat: on gitter][gitter badge]][Gitter] [![readme style: standard][readme style standard badge]][standard readme]

Ethereum Client-VM Connector API

The EVMC is the low-level ABI between Ethereum Virtual Machines (EVMs) and Ethereum Clients. On the EVM side it supports classic EVM1 and [ewasm]. On the Client-side it defines the interface for EVM implementations to access Ethereum environment and state.

Usage

Documentation

Please visit the [documentation].

Languages support

| Language | Supported Versions | Supported Compilers | Feature Support | |-------------------------------|----------------------|------------------------------|-------------------| | C | C99, C11 | GCC 8+, clang 9+, MSVC 2017+ | Host- and VM-side | | C++ | C++17 | GCC 8+, clang 9+, MSVC 2017+ | Host- and VM-side | | Go (bindings) | 1.11+ (with modules) | | Host-side only | | Rust (bindings)¹ | 2018 edition | 1.47.0 and newer | VM-side only | | Java (bindings)² | 11 | | Host-side only |

• ^↑ Rust support is limited and not complete yet, but it is mostly functional already. Breaking changes are possible at this stage.
• ^↑ Java support is in progress and the interface remains in flux. Breaking changes are possible at this stage.

Testing tools

• evmc run ([tools/evmc]) — executes bytecode in any EVMC-compatible VM implementation.
• evmc-vmtester ([tools/vmtester]) — can test any EVM implementation for compatibility with EVMC.

Related projects

EVMs

• [aleth-interpreter]
• [Daytona]
• [eip1962-evmc] (EIP-2003 style precompile)
• [evmjit]
• [evmone]
• [Hera]
• [Hera.rs]
• [ssvm-evmc]

Clients

• [aleth]
• [core-geth] (in progress)
• [erigon] (with silkworm)
• [evmc-js]
• [go-ethereum] (in progress)
• [nim-evmc]
• [phant] (in progress)
• [pyevm] (in progress)
• [pyethereum] (abandoned)
• [rust-ssvm] (Rust Host-side)
• [silkworm]
• [Solidity] (for integration testing)

Maintainers

• Alex Beregszaszi [@axic]
• Paweł Bylica [@chfast]

Contributing

[![chat: on gitter][gitter badge]][Gitter]

Talk with us on the [EVMC Gitter chat][Gitter].

License

[![license badge]][Apache License, Version 2.0]

Licensed under the [Apache License, Version 2.0].

Internal

Making new release

• Update CHANGELOG.md, put the release date, update release link.
• git add CHANGELOG.md.
• Tag new release: bumpversion --allow-dirty prerel.
• Prepare CHANGELOG for next release: add unreleased section and link.
• git add CHANGELOG.md.
• Start new release series: bumpversion --allow-dirty --no-tag minor.

[@axic]: https://github.com/axic [@chfast]: https://github.com/chfast [Apache License, Version 2.0]: LICENSE [documentation]: https://ethereum.github.io/evmc [ewasm]: https://github.com/ewasm/design [evmjit]: https://github.com/ethereum/evmjit [evmone]: https://github.com/ethereum/evmone [Hera]: https://github.com/ewasm/hera [Hera.rs]: https://github.com/ewasm/hera.rs [Daytona]: https://github.com/axic/daytona [eip1962-evmc]: https://github.com/axic/eip1962-evmc [erigon]: https://github.com/erigontech/erigon [ssvm-evmc]: https://github.com/second-state/ssvm-evmc [Gitter]: https://gitter.im/ethereum/evmc [aleth-interpreter]: https://github.com/ethereum/aleth/tree/master/libaleth-interpreter [aleth]: https://github.com/ethereum/aleth [Solidity]: https://github.com/ethereum/solidity [nim-evmc]: https://github.com/status-im/nim-evmc [go-ethereum]: https://github.com/ethereum/go-ethereum/pull/17954 [phant]: https://github.com/jsign/phant [pyevm]: https://github.com/ethereum/py-evm [pyethereum]: https://github.com/ethereum/pyethereum/pull/406 [silkworm]: https://github.com/erigontech/silkworm [core-geth]: https://github.com/etclabscore/core-geth/issues/55 [evmc-js]: https://github.com/RainBlock/evmc-js [rust-ssvm]: https://github.com/second-state/rust-ssvm [standard readme]: https://github.com/RichardLitt/standard-readme [tools/evmc]: https://github.com/ethereum/evmc/tree/master/tools/evmc [tools/vmtester]: https://github.com/ethereum/evmc/tree/master/tools/vmtester

[gitter badge]: https://img.shields.io/gitter/room/ethereum/evmc.svg [license badge]: https://img.shields.io/github/license/ethereum/evmc.svg?logo=apache [readme style standard badge]: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg