Add CDDLs #1422
Add CDDLs #1422
Conversation
|
Very nice! See cardano-scaling/cardano-blueprint#25 for an issue that aims to use these to create an api reference. |
|
|
||
| getCBOR.query = [9, shelleyQuery] | ||
|
|
||
| ;# include getSystemStart as getSystemStart |
There was a problem hiding this comment.
Does this mean that we need to provide ./consensus as an include path to cddlc? Would it be possible to say consensus/getSystemStart here and it would just work?
There was a problem hiding this comment.
Do check the cddlc.sh script in this PR, it shows how one would run cddlc. You can run it to see the results.
There was a problem hiding this comment.
Would it be possible to say consensus/getSystemStart here and it would just work?
No, I don't think that works. I seem to recall I tried and was not able to use it.
| unsafeIndefiniteSafeZone = [1] | ||
| genesisWindow = word64 | ||
|
|
||
| ;# import base |
There was a problem hiding this comment.
Can we use qualified or explicit imports? Then it would be more clear which rules come from this library. For example we could have eraStart = base.bound
ouroboros-consensus-cardano/cddl/node-to-client/localstatequery/consensus/getSystemStart.cddl
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
@jasagredo I se you added this tool. How should I try using this? How do you imagine the developer experience overall?
There was a problem hiding this comment.
For now this tool gets all the contents of the CDDLs but it does nothing with them. I am using it locally to debug the CBOR validator I'm trying to implement in cuddle.
Description
Add CDDL definitions for types that Consensus emits.