Skip to content

Update repository README to list correct contents #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gnidan merged 1 commit into from
Feb 13, 2025
Merged

Update repository README to list correct contents #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 33 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,10 @@ domain of experts. Without a mechanism for machine-to-human translation,
smart contract software quality comes at a higher cost, and any promise of
trust risks erosion.

[^1]: See [Debugging data format -
Wikipedia](https://en.wikipedia.org/wiki/Debugging_data_format)

[^2]: See [DWARF - Wikipedia](https://en.wikipedia.org/wiki/DWARF)

## Purpose of this repository

This repository serves as a home for the working group to design
a standard debugging data format for smart contracts on
This repository serves as a home for the **ethdebug/format** working group to
design a standard debugging data format for smart contracts on
Ethereum-compatible networks.

## Contents
Expand All @@ -50,12 +45,29 @@ This repository contains a
[`schemas/`](https://github.com/ethdebug/format/tree/main/schemas) directory
with the formal JSON Schemas defined by this project (in YAML format).

This repository also contains a number of NPM packages (currently unpublished):
- **@ethdebug/format**: A Node.js-compatible distribution of these schemas
- **@ethdebug/format-tests**: Contains a test suite for validating schemas and
testing examples/other constraints.
- **@ethdebug/format-web**: The docusaurus site source that powers this
project's homepage.
This repository also contains the source materials for the following NPM packages:
- **@ethdebug/format** in
[`packages/format/`](https://github.com/ethdebug/format/tree/main/packages/format)
distributes the formal schemas for use in TypeScript
or JavaScript projects, along with corresponding
type predicate functions[^3] to help maintain type-safety when reading
objects in these schemas.

- **@ethdebug/pointers** in
[`packages/pointers/`](https://github.com/ethdebug/format/tree/main/packages/pointers)
provides a functional reference implementation for dereferencing
[ethdebug/format/pointer](https://ethdebug.github.io/format/spec/pointer/overview)
objects against running raw EVM machine state.

For more about this reference implementation, please see accompanying
[Dereferencing pointers](https://ethdebug.github.io/format/docs/implementation-guides/pointers/)
implementation guide on this project's homepage.

- **@ethdebug/format-web** _(unpublished package)_ in
[`packages/web/`](https://github.com/ethdebug/format/tree/main/packages/web)
contains the materials for
the Docusaurus site powering
[this project's homepage](https://ethdebug.github.io/format).

## Developing locally

Expand All @@ -75,3 +87,11 @@ on any changes. This will open your browser to `http://localhost:3000/format`:
```console
yarn start
```

[^1]: See [Debugging data format -
Wikipedia](https://en.wikipedia.org/wiki/Debugging_data_format)

[^2]: See [DWARF - Wikipedia](https://en.wikipedia.org/wiki/DWARF)

[^3]: See [Using type predicates](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates)
section from TypeScript's Narrowing documentation.