Client-libs: emit machine-readable description of encodings
The aim of this Milestone is to emit a formal description of encodings which can serve both as documentation and as input for other programs. These descriptions fill a similar role to definition files in protobuf (and other similar systems).
Find a machine-readable format description language (DONE)
Deliverable: a design document which describes an existing or modified machine-readable format-description language with a rationale for the choice.
Current status: internal draft document being worked on
People: @martintomazic, @hhugo1, @raphael-proust
High-level plan
Handling data encoding of client-libs
Comparison of format description languages
Explanation for the need to support the on-chain binary format
Emit this format description language from data-encoding
Deliverable: data-encoding can output the format-description language to self-describe any of the encodings used in octez
Estimated time: unknown yet (depends on other deliverable)
Current status: not yet started
People: @martintomazic, @raphael-proust
-
Library to manipulate kaitai descriptions from OCaml (@hhugo1 , !9750 (merged)) -
Library to produce kaitai descriptions from data-encoding encodings (@martintomazic , @raphael-proust ) -
Boilerplate (!9722 (merged)) -
Full support for all of data-encoding (!9882 (merged), !9748 (merged))
-
-
Integration in the octez-codec
tool (@martintomazic , @raphael-proust, !9848 (merged)) -
Integration in the CI