feat(docs): Update voting docs, add cddl validation (#79)

* fix gen_vote_tx structure

* add cose import

* cleanup Earthfiles, add cddl-check target

* update jorm spec

* wip

* add cddl validation

* add cddl validation for immutable_ledger specs

* fix spelling

* add missing blueprint.cue files

* fix

* fix immutable ledger cddl definitions

* wip

* wip

* wip

* fix

* fix CI

* fix cat-ci version

Author: Mr-Leshiy

.config/dictionaries/project.dic

@@ -27,6 +27,7 @@ cardano
 carryforward
 CBOR
 cbork
+cddlc
 cdylib
 CEST
 chacha

docs/src/architecture/08_concepts/catalyst_voting/.pages

@@ -2,5 +2,5 @@ title: Catalyst Voting
 arrange:
     - crypto.md
     - gen_vote_tx.md
-    - jorm.md
-    - cat_v2.md
+    - v1.md
+    - v2.md

docs/src/architecture/08_concepts/catalyst_voting/cat_v2.md

@@ -0,0 +1,19 @@
+VERSION 0.8
+
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.2.23 AS cddl-ci
+
+check-cddl:
+    FROM cddl-ci+cddl-base
+
+    WORKDIR /cddl
+
+    COPY ./gen_vote_tx.cddl \
+         ./vote_tx_v2_public.cddl \
+         ./vote_tx_v2_private.cddl \
+         ./gen_vote_tx_cose_payload.cddl \
+        .
+
+    RUN cddlc -2 gen_vote_tx_cose_payload.cddl
+    RUN cddlc -2 gen_vote_tx.cddl
+    RUN cddlc -2 vote_tx_v2_public.cddl
+    RUN cddlc -2 vote_tx_v2_private.cddl

docs/src/architecture/08_concepts/catalyst_voting/cddl/Earthfile

@@ -0,0 +1,2 @@
+version: "1.0.0"
+project: name: "docs-catalyst-voting-cddl"

docs/src/architecture/08_concepts/catalyst_voting/cddl/blueprint.cue

@@ -1,31 +1,33 @@
-gen-vote-tx = [
-    tx-body,
+gen-vote-tx<choice-t, proof-t, prop-id-t> = [
+    tx-body<choice-t, proof-t, prop-id-t>,
     signature
 ]
 
-tx-body = [
+tx-body<choice-t, proof-t, prop-id-t> = [
     vote-type
     event,
-    votes,
+    votes<choice-t, proof-t, prop-id-t>,
     voters-data,
 ]
 
 vote-type = UUID ; e.g. Public or Private vote
 event = { * event-key => any }
 event-key = int / text
 
-votes = [+ vote]
-vote = [
-    choices,
-    proof \ null,
-    prop-id \ null,
+votes<choice-t, proof-t, prop-id-t> = [+ vote<choice-t, proof-t, prop-id-t>]
+vote<choice-t, proof-t, prop-id-t>  = [
+    choices<choice-t>,
+    proof<proof-t>,
+    prop-id<prop-id-t>,
 ]
-choices = [+ choice]
-choice = encoded-cbor
-proof = encoded-cbor
-prop-id = encoded-cbor
+choices<choice-t> = [+ choice<choice-t>]
+choice<choice-t> = #6.24(bytes .cbor choice-t) ; encoded-cbor
+proof<proof-t> = #6.24(bytes .cbor proof-t) ; encoded-cbor
+prop-id<prop-id-t> = #6.24(bytes .cbor prop-id-t) ; encoded-cbor
 
 voters-data = encoded-cbor
 
 UUID = #6.37(bytes) ; UUID type
-signature = #6.98(COSE_Sign) ; COSE signature
+signature = #6.98(cose.COSE_Sign) ; COSE signature
+
+;# import rfc9052 as cose

docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx.cddl

@@ -1,2 +1,2 @@
 cose-payload = blake2b-256
-blake2b-256 = #6.32782(bytes .size 32) ; Blake2b-256 hash bytes
+blake2b-256 = #6.32782(bytes .size 32) ; Blake2b-256 hash bytes

docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx_cose_payload.cddl

@@ -0,0 +1,19 @@
+vote-tx-v2 = gen-vote-tx<choice-data, proof-data, proposal>
+
+choice-data = ciphertext
+ciphertext = [group-element, group-element]
+
+proposal = UUID
+
+proof-data = zk-proof
+
+zk-proof = [[+ (announcement, ~ciphertext, r-response)], scalar]
+
+announcement = (group-element, group-element, group-element)
+r-response = (scalar, scalar, scalar)
+
+scalar = bytes .size 32
+group-element = bytes .size 32
+
+;# include gen_vote_tx
+

docs/src/architecture/08_concepts/catalyst_voting/cddl/vote_tx_v2.cddl

@@ -0,0 +1,8 @@
+vote-tx-v2-public = gen-vote-tx<choice-data, proof-data, proposal>
+
+choice-data = uint
+proof-data = undefined
+proposal = UUID
+
+;# include gen_vote_tx
+