Skip to main content

Implementation guides

This section of these docs serves to provide resources that guide readers who are looking to implement one or more components of ethdebug/format. Because of the distinct concerns involved in implementing this format on the compilation side vs. the concerns involved on the debugging side, this page lists and categorizes the available guides into the appropriate heading.

For debuggers

Guide: Dereferencing pointers

This guide provides readers with a tour of the @ethdebug/pointers TypeScript reference implementation, showing example concrete logic for how a debugger might process ethdebug/format pointers.

For an introduction to ethdebug/format pointers, please see the Pointer specification's Overview and Key concepts pages.

Other guides

Guides for other aspects of debugger-side ethdebug/format implementation are planned and still need to be written.

For compilers

No availble guides yet

Guides for implementing ethdebug/format support inside a compiler are planned and still need to be written.

Work in progress

Sadly, things are looking a little scarce right now. Please stay tuned as work on this effort progresses.

Interested in helping out? If you'd like to help with writing initial reference implementations for one or more schemas, please reach out in our Matrix.chat.