🚧 Dev ➾ Auto-Generate Comments at the Top of Compiled Michelson Files

[hu3man]

🔗 Epic|Feature Link

1167

🚥 Definition of Done

• [ ] 🎯 Planning and Design
• [ ] 🏎️ Dev Implementation (PR merged)
• [ ] ✍️ Release Notes Added
• [ ] 🏆 Product Acceptance

✅ To Do

No response

⚖️ Acceptance Criteria

✨ Functional:

• [ ] Comment includes compiler version
• [ ] Comment informs user what file it was compiled from

• [ ] Comment informs the user that Taqueria generated it

  📐 Non-Functional:

• [ ] ...

🔭 Scope

🙅‍♂️ Out of Scope:

• SmartPy or Archetype plugin work
• Modifications to Taquito

🧰 Work Description

Taqueria needs to add comments to the top of compiled Michelson files

The general flow will be:

1. User compiles a ligo contract
2. Michelson file is generated
3. Taqueria inserts a comment to the top of the Michelson file

The comment should be informative and valuable to the user. Some properties could include (version of compiler, source file, timestamp)

🦄 Sizing

2

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[jevonearth]

Here are two user stories to support this feature request.

As a dapp developer, I want to know the source of Michelson artifacts in my project, so it is easy for me and others to see where it came from (which compiler, what compiler version) and when it was produced.

As a technical reviewer of a tezos project, I would like to easily discover the provenance (which compiler, what version when compiled) of a Michelson artifact.