add comment which specifies a CBOR encoding/decoding profile

Mr-Leshiy · Mr-Leshiy · commit 2cde1b39048d · 2024-12-02T12:37:28.000+02:00
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx.cddl b/docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx.cddl
@@ -1,3 +1,6 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 gen-vote-tx<choice-t, proof-t, prop-id-t, voter-data-t> = [
     tx-body<choice-t, proof-t, prop-id-t, voter-data-t>,
     signature
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx_cose_payload.cddl b/docs/src/architecture/08_concepts/catalyst_voting/cddl/gen_vote_tx_cose_payload.cddl
@@ -1,2 +1,5 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 cose-payload = blake2b-256
 blake2b-256 = #6.32782(bytes .size 32) ; Blake2b-256 hash bytes
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/cddl/vote_tx_v2_private.cddl b/docs/src/architecture/08_concepts/catalyst_voting/cddl/vote_tx_v2_private.cddl
@@ -1,3 +1,6 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 vote-tx-v2<voter-data-t> = gen-vote-tx<choice-data, proof-data, proposal, voter-data-t>
 
 choice-data = ciphertext
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/cddl/vote_tx_v2_public.cddl b/docs/src/architecture/08_concepts/catalyst_voting/cddl/vote_tx_v2_public.cddl
@@ -1,3 +1,6 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 vote-tx-v2-public<voter-data-t> = gen-vote-tx<choice-data, proof-data, proposal, voter-data-t>
 
 choice-data = uint
diff --git a/docs/src/architecture/08_concepts/immutable_ledger/cddl/block.cddl b/docs/src/architecture/08_concepts/immutable_ledger/cddl/block.cddl
@@ -1,3 +1,6 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 block = [
     block-header,
     block-data,
diff --git a/docs/src/architecture/08_concepts/immutable_ledger/cddl/genesis_to_prev_hash.cddl b/docs/src/architecture/08_concepts/immutable_ledger/cddl/genesis_to_prev_hash.cddl
@@ -1,3 +1,6 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 genesis-to-prev-hash = [
     chain-id: ULID,
     timestamp: #6.1(uint .ge 1722470400), ; Epoch-based date/time
diff --git a/docs/src/architecture/08_concepts/immutable_ledger/cddl/hash.cddl b/docs/src/architecture/08_concepts/immutable_ledger/cddl/hash.cddl
@@ -1,3 +1,6 @@
+; All encoders/decoders of this specification must follow deterministic cbor encoding rules
+; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
+
 hash-bytes = (
   #6.32781(bytes) / ; Blake3 hash
   #6.32782(bytes) / ; Blake2b hash
