Add eWASM Contract Interface specification #29
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # eWASM Contract Interface (ECI) Specification; Version 0 | ||
|
|
||
| The eWASM Contract Interface (ECI) specifies the structure of a contract module. | ||
|
|
||
| ### Wire format | ||
|
|
||
| Every contract must be stored in the [WebAssembly Binary Encoding](https://github.com/WebAssembly/design/blob/master/BinaryEncoding.md) format (in short, WASM bytecode). | ||
|
|
||
| ### Imports | ||
|
|
||
| A contract can only import symbols specified in the [Ethereum Environment Interface](./eth_interface.md). | ||
|
|
||
| ### Exports | ||
|
|
||
| A contract must have exactly two exported symbols: | ||
| - `memory`: the shared memory space available for the EEI to write into. | ||
| - `main`: a function with no parameters and no result value. | ||
|
|
||
| ### Entry point | ||
|
|
||
| The method exported as `main` will be executed by the VM. | ||
|
There was a problem hiding this comment. This functionality could be replaces with There was a problem hiding this comment. The
|
||
|
|
||
| ### Debug-mode | ||
|
|
||
| Debug-mode is a special VM option, where an additional set of debugging interfaces are available to contracts. On a live VM, any bytecode trying to import these | ||
| symbols should be rejected. | ||
|
|
||
| The imports are available under the `debug` namespace: | ||
| - `print(i32 offset, i32 length)`: print a string as pointed by `offset` | ||
| - `printHex(i32 offset, i32 length)`: print a hex representation of the memory pointed to by `offset` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be optional and we could assume that kernel will also just have access to memory. Currently we also export the memory becuase there is no other way to accesses it. But according to JSapi we should be able to create a wasm instance with memory externally defined (i think).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The memory supplied to instantiate will be copied over to the instance memory. It is not a pointer as far as I see.