[go: up one dir, main page]

Update data encoding

What

Update data-encoding (and json-data-encoding) to latest released version (1.0.1).

Why

For the monorepoisation, we want to move data-encoding into tezos/tezos. For this to happen smoothly, we need the imported data-encoding to be as-similar-as-possible to the one used by octez as an opam dependency. Hence the update.

How

  1. Update manifest and propagate to build files (opam files, lock files, opam-repo hashes).
  2. Update the code of kaitai-related files which use the internal representation of data-encoding to derive a kaitai description. (Note: after data-encoding is brought into the monorepo, the data-encoding→kaitai translation should become a part of data-encoding itself.)
  3. Update the rest of the code.
    • Some minor changes of interface related to naming/documentation of compact encodings required some addition to the protocol-environment
    • The new V1 module (to version the Data_encoding encoding combinators which currently live at top level) was occasionally shadowing other unrelated V1 modules in let open Data_encoding in … expressions requiring a change to let open Data_encoding.V1 in …
    • Some minor changes here and there due to internal representation changes.

Manually testing the MR

Checklist

  • Document the interface of any function added or modified (see the coding guidelines)
  • Document any change to the user interface, including configuration parameters (see node configuration)
  • Provide automatic testing (see the testing guide).
  • For new features and bug fixes, add an item in the appropriate changelog (docs/protocols/alpha.rst for the protocol and the environment, CHANGES.rst at the root of the repository for everything else).
  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR

Merge request reports

Loading