[go: up one dir, main page]

Clarify the contents of Michelson references

There are two Michelson references today:

  • a static one, that provides details about the place, the purpose, and the inner workings of the language in the blockchain;
  • an interactive one, where searching for an instruction or a type is made very convenient, and the results are ergonomically displayed.

However, these two references also share a lot of the same contents, such as the description of types and instructions, their typing and semantics rules.
As a consequence, this makes things harder for developers to keep both references up-to-date, since they often have to replicate changes from one of them to the other.

One way to solve this is to explicit the role of each reference, and ensure that their contents are disjoint, by making them point to one another wherever needed.

Thus, we propose that the static reference contains:

  • explanations about what is the Michelson language;
  • how to read typing and semantics rules;
  • examples of contracts;
  • but not the details about each type and instruction;

and that the interactive reference contains:

  • the exhaustive list of types and instructions;
  • their typing and semantics rules.

This could be achieved following the steps below:

Edited by Nicolas Ayache