feat(docs): Project overview and spelling. #45
Conversation
| The security of smart contracts hinges on the availability of robust debugging tools. As the compiler optimizes a contract, it may move instructions around or remove them thus weakening its relationship with the original source code. The debugger then faces the challenging task of reversing these transformations to enrich the often cryptic artifacts with contexts mapping back to the contract's source. | ||
|
|
||
| The ETH debug standard aims to bridge this intricate dichotomy between the compiler and debugger, guided by the following key goals: | ||
|
|
||
| - **Minimal Overhead**: Extend compiler output without duplication or excessive disk footprint. | ||
| - **Language Agnostic**: Remain independent of any specific programming language or compiler, ensuring wide applicability within the Ethereum Virtual Machine (EVM) ecosystem. | ||
| - **Robust Interface**: Provide a comprehensive and standardized interface for debuggers, enabling a rich and industry-standard debugging experience for developers. |
There was a problem hiding this comment.
This is great stuff. Should we also mention in this subsection something about how we want to build a debugging data format? We mention the problem but maybe a sentence at the end (after your bulleted list), something like "To this end, we seek to design and specify a debugging data format for EVM languages." (nothing fancy, since the following sections will expand on all these points)
There was a problem hiding this comment.
I have extended to add:
- info about primary audience (tool devs)
- downstream benefits for app developers / ecosystem
To this end, we seek to design and specify a debugging data format for EVM languages. We hope this format will empower tooling developers building debuggers and analysis frameworks, and ultimately enable application developers to benefit from enhanced debugging capabilities to build more robust and secure smart contracts.
No description provided.