status-im/evmc
2
0
Fork 0
mirror of https://github.com/status-im/evmc.git synced 2025-02-23 00:18:24 +00:00
Code Issues Projects Releases Wiki Activity

Document versioning

Browse Source
This commit is contained in:
Paweł Bylica 2018-09-06 16:13:45 +02:00
parent 75bcc02ab7
commit a282af96d5
No known key found for this signature in database
GPG Key ID: 7A0C037434FE77EF
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/EVMC.md
View File

@ -6,7 +6,16 @@ On the Client-side it defines the interface for EVM implementations
to access Ethereum environment and state.
## Modules
# Versioning {#versioning}
The EVMC project uses [Semantic Versioning](https://semver.org).
Moreover, the _MAJOR_ version number is also referenced as the EVMC ABI version.
This ABI version is available to VM and Host implementations by ::EVMC_ABI_VERSION.
For example EVMC 3.2.1 would have ABI version 3 and therefore this project release
can be referenced as EVMC ABIv3 or just EVMC 3.
# Modules
- [EVMC](@ref EVMC)
– the main component that defines API for VMs and Clients (Hosts).

9
include/evmc/evmc.h
View File

@ -23,7 +23,14 @@ extern "C" {
enum
{
/** The EVMC ABI version number of the interface declared in this file. */
/**
* The EVMC ABI version number of the interface declared in this file.
*
* The EVMC ABI version always equals the major version number of the EVMC project.
* The Host SHOULD check if the ABI versions match when dynamically loading VMs.
*
* @see @ref versioning
*/
EVMC_ABI_VERSION = 6
};