-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 changed file
with
17 additions
and
34 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,60 +1,43 @@ | ||
| # EVM Toolkit (`etk`) | ||
| # EVM++ Toolkit (`etkpp`) | ||
|
|
||
| [](https://github.com/quilt/etk) | ||
| [](https://t.me/joinchat/c-Cusp7Zh1tiM2Vh) | ||
| [](https://github.com/quilt/etk/actions) | ||
| [](https://github.com/gzanitti/etkpp) | ||
|
|
||
| `etk` is a collection of tools for writing, reading, and analyzing EVM bytecode. | ||
| `etk` is a for of the original [ETK](https://github.com/quilt/etk), a collection of tools for writing, reading, and analyzing EVM bytecode, but with new features, tweaks and small modifications. | ||
|
|
||
| ## Documentation | ||
|
|
||
| For the time being, you can refer to the original ETK documentation. We will soon publish a documentation adapted to the new features included in ETK++. | ||
|
|
||
| The [`etk` book](https://quilt.github.io/etk) is the most comprehensive guide to using `etk`. | ||
| * [Introduction](https://quilt.github.io/etk) | ||
| * [Usage](https://quilt.github.io/etk/ch01-cli/index.html) | ||
| * [`eas`](https://quilt.github.io/etk/ch01-cli/ch01-eas.html) | ||
| * [`disease`](https://quilt.github.io/etk/ch01-cli/ch02-disease.html) | ||
| * [Language & Syntax](https://quilt.github.io/etk/ch02-lang/index.html) | ||
|
|
||
| There are also several examples in the [`etk-asm/tests/asm`](etk-asm/tests/asm) directory. For further questions, join us on [Telegram](https://t.me/joinchat/c-Cusp7Zh1tiM2Vh). | ||
| - [Introduction](https://quilt.github.io/etk) | ||
| - [Usage](https://quilt.github.io/etk/ch01-cli/index.html) | ||
| - [`eas`](https://quilt.github.io/etk/ch01-cli/ch01-eas.html) | ||
| - [`disease`](https://quilt.github.io/etk/ch01-cli/ch02-disease.html) | ||
| - [Language & Syntax](https://quilt.github.io/etk/ch02-lang/index.html) | ||
|
|
||
| There are also several examples in the [`etk-asm/tests/asm`](etk-asm/tests/asm) directory. | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ### Installation | ||
|
|
||
| `etk` requires the latest `rustc` from the stable channel. | ||
| `etk++` requires the latest `rustc` from the stable channel. | ||
|
|
||
| ```console | ||
| cargo install --features cli etk-asm etk-dasm | ||
| ``` | ||
|
|
||
| #### Project Templates | ||
| * [`etk`-Foundry Template](https://github.com/quilt/etk-foundry-template) | ||
|
|
||
| #### Syntax Highlighting | ||
| * [`vim-etk`](https://github.com/quilt/vim-etk) | ||
|
|
||
| ### Usage | ||
| `contract.etk`: | ||
| ```asm | ||
| push1 42 | ||
| push1 13 | ||
| add | ||
| pop | ||
| ``` | ||
| ```console | ||
| $ eas contract.etk out.hex | ||
| $ disease --hex-file out.hex | ||
| 0: push1 0x2a | ||
| 2: push1 0x0d | ||
| 4: add | ||
| 5: pop | ||
| ``` | ||
| ### Dependencies | ||
|
|
||
| `ecfg` requires z3 to build | ||
|
|
||
| Ubuntu Installation Instructions (example): | ||
|
|
||
| ```console | ||
| sudo apt-get update -y | ||
| sudo apt-get install -y z3 | ||
| sudo apt-get install -y libz3-dev | ||
| ``` | ||
|
|
||
| Check the system logs to confirm that there are no related errors. |