-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
17 additions
and
16 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,16 +1,15 @@ | ||
High level | ||
This is a C library to facilitate IO interactions of applications running in the cartesi-machine. | ||
|
||
- @ref libcmt\_rollup | ||
The high level @ref libcmt\_rollup API provides functions for common operations, such as generating vouchers, notices, retrieving the next input, etc. | ||
Check the [cartesi documentation](https://docs.cartesi.io/) for an introduction and explanation of the rollup interaction model. | ||
|
||
Utility | ||
In addition to the above mentioned module, we provide @ref libcmt\_io\_driver, a thin abstraction of the linux kernel driver. | ||
|
||
- @ref libcmt\_abi | ||
- @ref libcmt\_buf | ||
- @ref libcmt\_merkle | ||
- @ref libcmt\_keccak | ||
And finally there are the utility modules used by the high level API. | ||
- @ref libcmt\_abi is a Ethereum Virtual Machine Application Binary Interface (EVM-ABI) encoder / decoder. | ||
- @ref libcmt\_buf is a bounds checking buffer. | ||
- @ref libcmt\_merkle is a sparse merkle tree implementation on top of keccak. | ||
- @ref libcmt\_keccak is the hashing function used extensively by Ethereum. | ||
|
||
Low level | ||
|
||
- @ref libcmt\_io\_driver | ||
|
||
Download the static library from [cartesi tools](https://github.com/cartesi/machine-emulator-tools/). | ||
The header files and a compiled RISC-V version of this library can be found [here](https://github.com/cartesi/machine-emulator-tools/). | ||
We also provide `.pc` (pkg-config) files to facilitate linking. |
This file contains 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 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