Skip to content

Commit ff3ea29

Browse files
stevenjstevenj
committed
docs(docs): Add the ballot checkpoint design specification to the docs
1 parent ad47d0e commit ff3ea29

26 files changed

+1459
-1306
lines changed

‎docs/src/architecture/08_concepts/signed_doc/cddl/blake3.cddl‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
; Blake3 Hash (Digest Size is determined by length of bytes)
2+
3+
4+
; Blake3 Hash (Digest Size is determined by length of bytes)
5+
blake3 = #6.32781(bytes)

‎docs/src/architecture/08_concepts/signed_doc/cddl/contest_ballot_checkpoint.cddl‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
; Catalyst Ballot Checkpoint data object.
2+
;
3+
; This serves as a checkpoint that collects new `contest-ballot-payload` documents
4+
; that have been observed by a bulleting board.
5+
;
6+
; It will be created periodically during the voting period to allow proofs of inclusion
7+
; to be firmly anchored and repeatably verifiable, and to allow voters or auditors to confirm
8+
; a bulletin board acted honestly and included all valid ballots it detected.
9+
;
10+
; At another interval (which may be the same or different), a roll-up of the latest
11+
; checkpoint is submitted to a blockchain to provide an immutable anchor of the
12+
; ballots collected by a bulletin board up to that point in time.
13+
14+
15+
; Catalyst Ballot Checkpoint Payload data object.
16+
contest-ballot-checkpoint = {
17+
"smt-root" : smt-root,
18+
"smt-entries" : smt-entries,
19+
}
20+
21+
; The SMT Root hash is a Blake 3 256bit digest Hash.
22+
smt-root = blake3
23+
24+
; Blake3 Hash (Digest Size is determined by length of bytes)
25+
blake3 = #6.32781(bytes)
26+
27+
; The Count of all Documents held by the SMT.
28+
smt-entries = uint

‎docs/src/architecture/08_concepts/signed_doc/cddl/smt_entries.cddl‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
; The Count of all Documents held by the SMT.
2+
3+
4+
; The Count of all Documents held by the SMT.
5+
smt-entries = uint

‎docs/src/architecture/08_concepts/signed_doc/cddl/smt_root.cddl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
; The SMT Root hash is a Blake 3 256bit digest Hash.
2+
3+
4+
; The SMT Root hash is a Blake 3 256bit digest Hash.
5+
smt-root = blake3
6+
7+
; Blake3 Hash (Digest Size is determined by length of bytes)
8+
blake3 = #6.32781(bytes)

‎docs/src/architecture/08_concepts/signed_doc/diagrams/all.dot‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -547,21 +547,21 @@ digraph "All" {
547547
];
548548

549549

550-
"Rep Nomination" [
551-
id="Rep Nomination";
550+
"Contest Ballot Checkpoint" [
551+
id="Contest Ballot Checkpoint";
552552
label=<
553553
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
554554
<TR>
555-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="./docs/rep_nomination/">
556-
<FONT COLOR="#ffffff"><B> Rep Nomination </B></FONT>
555+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="./docs/contest_ballot_checkpoint/">
556+
<FONT COLOR="#ffffff"><B> Contest Ballot Checkpoint </B></FONT>
557557
</TD>
558558
</TR>
559559
<TR>
560560
<TD ALIGN="LEFT" PORT="content type" BGCOLOR="#e7e2dd">
561561
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
562562
<TR>
563563
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">content type</FONT></TD>
564-
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>application/json</I></FONT></TD>
564+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>application/cbor</I></FONT></TD>
565565
</TR>
566566
</TABLE>
567567
</TD>
@@ -571,7 +571,7 @@ digraph "All" {
571571
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
572572
<TR>
573573
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
574-
<TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>bf9abd97-5d1f-4429-8e80-740fea371a9c</I></B></FONT></TD>
574+
<TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>58608925-bda3-47df-b39a-ae0d0a1dd6ed</I></B></FONT></TD>
575575
</TR>
576576
</TABLE>
577577
</TD>
@@ -601,37 +601,27 @@ digraph "All" {
601601
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
602602
<TR>
603603
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ref</FONT></TD>
604-
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Rep Profile</I></FONT></TD>
604+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Contest Ballot</I></FONT></TD>
605605
</TR>
606606
</TABLE>
607607
</TD>
608608
</TR>
609609
<TR>
610-
<TD ALIGN="LEFT" PORT="template" BGCOLOR="#b8b5b0">
611-
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
612-
<TR>
613-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">template</FONT></TD>
614-
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Rep Nomination Form Template</I></FONT></TD>
615-
</TR>
616-
</TABLE>
617-
</TD>
618-
</TR>
619-
<TR>
620-
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#e7e2dd">
610+
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
621611
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
622612
<TR>
623-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">revocations</FONT></TD>
624-
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Version Revocations</I></FONT></TD>
613+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
614+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Contest Parameters</I></FONT></TD>
625615
</TR>
626616
</TABLE>
627617
</TD>
628618
</TR>
629619
<TR>
630-
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
620+
<TD ALIGN="LEFT" PORT="chain" BGCOLOR="#e7e2dd">
631621
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
632622
<TR>
633-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
634-
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Contest Parameters</I></FONT></TD>
623+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">chain</FONT></TD>
624+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Chain Link</I></FONT></TD>
635625
</TR>
636626
</TABLE>
637627
</TD>
@@ -642,13 +632,13 @@ digraph "All" {
642632
];
643633

644634

645-
"Contest Ballot Register" [
646-
id="Contest Ballot Register";
635+
"Rep Nomination" [
636+
id="Rep Nomination";
647637
label=<
648638
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
649639
<TR>
650-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="./docs/contest_ballot_register/">
651-
<FONT COLOR="#ffffff"><B> Contest Ballot Register </B></FONT>
640+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="./docs/rep_nomination/">
641+
<FONT COLOR="#ffffff"><B> Rep Nomination </B></FONT>
652642
</TD>
653643
</TR>
654644
<TR>
@@ -666,7 +656,7 @@ digraph "All" {
666656
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
667657
<TR>
668658
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
669-
<TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>58608925-bda3-47df-b39a-ae0d0a1dd6ed</I></B></FONT></TD>
659+
<TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>bf9abd97-5d1f-4429-8e80-740fea371a9c</I></B></FONT></TD>
670660
</TR>
671661
</TABLE>
672662
</TD>
@@ -696,13 +686,23 @@ digraph "All" {
696686
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
697687
<TR>
698688
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ref</FONT></TD>
699-
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Rep Nomination</I></FONT></TD>
689+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Rep Profile</I></FONT></TD>
700690
</TR>
701691
</TABLE>
702692
</TD>
703693
</TR>
704694
<TR>
705-
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#b8b5b0">
695+
<TD ALIGN="LEFT" PORT="template" BGCOLOR="#b8b5b0">
696+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
697+
<TR>
698+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">template</FONT></TD>
699+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Rep Nomination Form Template</I></FONT></TD>
700+
</TR>
701+
</TABLE>
702+
</TD>
703+
</TR>
704+
<TR>
705+
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#e7e2dd">
706706
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
707707
<TR>
708708
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">revocations</FONT></TD>
@@ -712,7 +712,7 @@ digraph "All" {
712712
</TD>
713713
</TR>
714714
<TR>
715-
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
715+
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
716716
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
717717
<TR>
718718
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
@@ -1812,8 +1812,8 @@ digraph "All" {
18121812
"Category Parameters Form Template":"parameters":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
18131813
"Comment Moderation Action":"ref":e -> "Proposal Comment":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
18141814
"Contest Ballot":"parameters":e -> "Contest Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
1815-
"Contest Ballot Register":"ref":e -> "Rep Nomination":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
1816-
"Contest Ballot Register":"parameters":e -> "Contest Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
1815+
"Contest Ballot Checkpoint":"ref":e -> "Contest Ballot":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
1816+
"Contest Ballot Checkpoint":"parameters":e -> "Contest Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
18171817
"Contest Delegation":"ref":e -> "Rep Nomination":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
18181818
"Contest Delegation":"parameters":e -> "Contest Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
18191819
"Contest Parameters":"template":e -> "Contest Parameters Form Template":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]

0 commit comments

Comments
 (0)