feat(docs): Signed object design spec.

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

@@ -0,0 +1,5 @@
+title: Catalyst Documents
+arrange:
+- proposal.md
+- review.md
+- comment.md

docs/src/architecture/08_concepts/catalyst_docs/comment.md

@@ -0,0 +1,119 @@
+---
+Title: Catalyst Comment Document
+Category: Catalyst
+Status: Proposed
+Authors:
+    - Steven Johnson <[email protected]>
+Implementors:
+    - Catalyst Fund 14
+Discussions: []
+Created: 2024-12-29
+License: CC-BY-4.0
+---
+
+## Abstract
+
+## Comment Document
+
+This is a document which provides a comment against a particular [Proposal Document].
+
+### Specification
+
+Catalyst Comment document is a [Catalyst Signed Document],
+so its fully follows the structure of the [Catalyst Signed Document] specification.
+
+#### Metadata Fields
+
+A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
+
+* [`type`](./../signed_doc/spec.md#type): `b679ded3-0e7c-41ba-89f8-da62a17898ea` [UUID] value.
+
+  ```CDDL
+  "type" => 37(h'b679ded30e7c41ba89f8da62a17898ea')
+  ```
+
+* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
+  [Catalyst Signed Document content] must be in [JSON] format.
+
+  ```CDDL
+  3 => 30
+  ```
+
+* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
+  [Catalyst Signed Document content] must be [Brotli] compressed.
+
+  ```CDDL
+  "content-type" => "br"
+  ```
+
+* [`ref`](./../signed_doc/meta.md#ref-document-reference).
+  Reference to a related [Proposal Document].
+* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0b8424d4-ebfd-46e3-9577-1775a69d290c` value,
+  [comment template type](#comment-template).
+
+  ```CDDL
+  "template" => 37(h'0b8424d4ebfd46e395771775a69d290c')
+  ```
+
+* [`reply`](./../signed_doc/meta.md#reply-reply-reference) (optional).
+  A reference to another comment,
+  where the comment is in reply to the referenced comment.
+  Comments may only reply to a single other comment document.
+  The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id),
+  but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver).
+
+* [`section`](./../signed_doc/meta.md#section-section-reference) (optional).
+  Used when the comment only applies to a specific section to the document being commented upon,
+  and not the entire document.
+
+#### Content format
+
+TODO
+
+## Comment Template
+
+This document pr provides the template structure which a Comment must be formatted to, and validated against.
+
+### Specification
+
+Catalyst Comment Template document is a [Catalyst Signed Document],
+so its fully follows the structure of the [Catalyst Signed Document] specification.
+
+#### Metadata Fields
+
+A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
+
+* [`type`](./../signed_doc/spec.md#type): `0b8424d4-ebfd-46e3-9577-1775a69d290c` [UUID] value.
+
+  ```CDDL
+  "type" => 37(h'0b8424d4ebfd46e395771775a69d290c')
+  ```
+
+* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
+  [Catalyst Signed Document content] must be in [JSON] format.
+
+  ```CDDL
+  3 => 30
+  ```
+
+* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
+  [Catalyst Signed Document content] must be [Brotli] compressed.
+
+  ```CDDL
+  "content-type" => "br"
+  ```
+
+#### Content format
+
+TODO
+
+## Copyright
+
+This document is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
+
+[Catalyst Signed Document]: ./../signed_doc/spec.md
+[Catalyst Signed Document content]: ./../signed_doc/spec.md#signed-object-content
+[Proposal Document]: ./proposal.md
+[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
+[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
+[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html

docs/src/architecture/08_concepts/catalyst_docs/proposal.md

@@ -0,0 +1,109 @@
+---
+Title: Catalyst Proposal Document
+Category: Catalyst
+Status: Proposed
+Authors:
+    - Steven Johnson <[email protected]>
+Implementors:
+    - Catalyst Fund 14
+Discussions: []
+Created: 2024-12-29
+License: CC-BY-4.0
+---
+
+## Abstract
+
+## Proposal Document
+
+This is a document, formatted against the referenced proposal template, which defines a proposal which may be submitted
+for consideration under one or more brand campaign categories.
+
+The brand, campaign and category are not part of the document because the document can exist outside this boundary.
+They are defined when a specific document is submitted for consideration.
+
+### Specification
+
+Catalyst Proposal document is a [Catalyst Signed Document],
+so its fully follows the structure of the [Catalyst Signed Document] specification.
+
+#### Metadata Fields
+
+A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
+
+* [`type`](./../signed_doc/spec.md#type): `7808d2ba-d511-40af-84e8-c0d1625fdfdc` [UUID] value.
+
+  ```CDDL
+  "type" => 37(h'7808d2bad51140af84e8c0d1625fdfdc')
+  ```
+
+* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
+  [Catalyst Signed Document content] must be in [JSON] format.
+
+  ```CDDL
+  3 => 30
+  ```
+
+* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
+  [Catalyst Signed Document content] must be [Brotli] compressed.
+
+  ```CDDL
+  "content-type" => "br"
+  ```
+
+* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` value,
+  [proposal template type](#proposal-template).
+
+  ```CDDL
+  "template" => 37(h'0ce8ab3892584fbca62e7faa6e58318f')
+  ```
+
+#### Content format
+
+TODO
+
+## Proposal Template
+
+This document provides the template structure which a Proposal must be formatted to, and validated against.
+
+### Specification
+
+Catalyst Proposal Template document is a [Catalyst Signed Document],
+so its fully follows the structure of the [Catalyst Signed Document] specification.
+
+#### Metadata Fields
+
+A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
+
+* [`type`](./../signed_doc/spec.md#type): `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` [UUID] value.
+
+  ```CDDL
+  "type" => 37(h'0ce8ab3892584fbca62e7faa6e58318f')
+  ```
+
+* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
+  [Catalyst Signed Document content] must be in [JSON] format.
+
+  ```CDDL
+  3 => 30
+  ```
+
+* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
+  [Catalyst Signed Document content] must be [Brotli] compressed.
+
+  ```CDDL
+  "content-type" => "br"
+  ```
+
+#### Content format
+
+TODO
+
+## Copyright
+
+This document is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
+
+[Catalyst Signed Document]: ./../signed_doc/spec.md
+[Catalyst Signed Document content]: ./../signed_doc/spec.md#signed-object-content
+[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
+[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
+[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html

docs/src/architecture/08_concepts/catalyst_docs/review.md

@@ -0,0 +1,105 @@
+---
+Title: Catalyst Review Document
+Category: Catalyst
+Status: Proposed
+Authors:
+    - Steven Johnson <[email protected]>
+Implementors:
+    - Catalyst Fund 14
+Discussions: []
+Created: 2024-12-29
+License: CC-BY-4.0
+---
+
+## Abstract
+
+## Review Document
+
+TODO
+
+### Specification
+
+Catalyst Review document is a [Catalyst Signed Document],
+so its fully follows the structure of the [Catalyst Signed Document] specification.
+
+#### Metadata Fields
+
+A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
+
+* [`type`](./../signed_doc/spec.md#type): `e4caf5f0-098b-45fd-94f3-0702a4573db5` [UUID] value.
+
+  ```CDDL
+  "type" => 37(h'e4caf5f0098b45fd94f30702a4573db5')
+  ```
+
+* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
+  [Catalyst Signed Document content] must be in [JSON] format.
+
+  ```CDDL
+  3 => 30
+  ```
+
+* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
+  [Catalyst Signed Document content] must be [Brotli] compressed.
+
+  ```CDDL
+  "content-type" => "br"
+  ```
+
+* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value,
+  [review template type](#review-template).
+
+  ```CDDL
+  "template" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc')
+  ```
+
+#### Content format
+
+TODO
+
+## Review Template
+
+TODO
+
+### Specification
+
+Catalyst Review Template document is a [Catalyst Signed Document],
+so its fully follows the structure of the [Catalyst Signed Document] specification.
+
+#### Metadata Fields
+
+A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
+
+* [`type`](./../signed_doc/spec.md#type): `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` [UUID] value.
+
+  ```CDDL
+  "type" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc')
+  ```
+
+* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
+  [Catalyst Signed Document content] must be in [JSON] format.
+
+  ```CDDL
+  3 => 30
+  ```
+
+* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
+  [Catalyst Signed Document content] must be [Brotli] compressed.
+
+  ```CDDL
+  "content-type" => "br"
+  ```
+
+#### Content format
+
+TODO
+
+## Copyright
+
+This document is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
+
+[Catalyst Signed Document]: ./../signed_doc/spec.md
+[Catalyst Signed Document content]: ./../signed_doc/spec.md#signed-object-content
+[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
+[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
+[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html

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

@@ -10,10 +10,8 @@ check-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/gen_vote_tx.cddl

@@ -2,22 +2,10 @@
 ; 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
-]
-
-tx-body<choice-t, proof-t, prop-id-t, voter-data-t> = [
-    vote-type,
-    event,
     votes<choice-t, proof-t, prop-id-t>,
     voter-data<voter-data-t>,
 ]
 
-vote-type = UUID ; e.g. Public or Private vote
-event = { * event-key => event-value }
-event-key = int / text
-event-value = any
-
 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>,
@@ -30,8 +18,3 @@ 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
 
 voter-data<voter-data-t> = #6.24(bytes .cbor voter-data-t) ; encoded-cbor
-
-UUID = #6.37(bytes) ; UUID type
-signature = #6.98(cose.COSE_Sign) ; COSE signature
-
-;# import rfc9052 as cose