Skip to content
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.

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

Define schema for representing data types #46

Closed
wants to merge 1 commit into from
Closed

Conversation

gnidan
Copy link
Member

@gnidan gnidan commented Dec 14, 2023

(Pardon the short description and lack of commit sanity, but I'm opening this PR in hopes Fleek will deploy a preview build. [didn't work... stealing the main Fleek URL])

This PR proposes to define the ethdebug/format/type JSON schema for representing known and unknown data types in a machine-readable way (so that a compiler can tell a debugger about types).

This takes the organization approach to do the following:

  • Define a base schema that doesn't know about uints or strings, etc. It defines the syntactic form of elementary types vs. complex types (types that compose other types). [I imagine we'll add algebraic types to this distinction soon]
  • Define a canonical type schema that imposes restrictions on known kinds of types, like to assert that uint types must be specified with a certain number of bits.

Current status

  • This PR includes an overview of the ethdebug/format/type schema and explanation of the approach described above. See page preview online.
  • This PR includes an initial draft of ethdebug/format/type/base, along with explanation of key concepts and some examples. See page preview online.
  • This PR includes placeholder files for the full schema / spec page about it. Don't bother seeing page preview online.

@gnidan gnidan changed the title Define **ethdebug/format/type** schema for representing data types Define schema for representing data types Dec 14, 2023
@gnidan
Copy link
Member Author

gnidan commented Dec 22, 2023

Closing this in favor of #48

@gnidan gnidan closed this Dec 22, 2023
@gnidan gnidan deleted the schema-ideas branch December 22, 2023 04:45
@gnidan gnidan restored the schema-ideas branch December 22, 2023 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant