Liqwid-Labs / agora

Governance modules for Cardano protocols

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

No 'UTXO diagram' specification.

jhodgdev opened this issue · comments

When producing UTXO transition diagrams, we should abide to a standard format. This standard format needs to be documented in a file in docs/meta. This will be useful for new specs writers and serve as a 'legend' for those looking at UTXO diagrams in the specs. Wherever a UTXO diagram appears in the specs, a hyperlink to the schema should be included.

An example of what we could produce can be found here.

Yeah, I'm definitely a big fan of the idea. I would say that we do want to have as little visual noise as possible. With the above example I have a hard time determining what is a script, a redeemer, etc. Could we colour code it? That would be sufficient to help it I feel.

Heck, if we want to overengineer it we could use the Haskell Graphviz library and make a DSL :)

100% agree on finding the above a little hard to understand. To be honest, I have found all UTXO diagram solutions I have come across at MLabs a little wanting. Would love to be able to create a new standard.

And that DSL idea is 🔥

Closing this. We'll use draw.io where it's useful due to the relatively decent integration with Notion.