Merge pull request #173 from aion-dk/type-changes

Vote encoding - part 2 (Type changes)
aion-dk · Jun 2, 2022 · d5fa31e · d5fa31e
2 parents 95a181d + 9cf9e19
commit d5fa31e
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 28 deletions.
diff --git a/lib/av_client/actions/construct_ballot_cryptograms.ts b/lib/av_client/actions/construct_ballot_cryptograms.ts
@@ -12,6 +12,7 @@ import {
   CastVoteRecord,
   ClientState,
   ContestMap,
+  MarkingType,
   OpenableEnvelope
 } from '../types';
 
@@ -20,11 +21,14 @@ import {
 } from '../errors';
 import { generatePedersenCommitment } from '../crypto/pedersen_commitment';
 
-const DEFAULT_MARKING_TYPE = {
-  style: "regular",
-  codeSize: 1,
+const DEFAULT_MARKING_TYPE: MarkingType = {
   minMarks: 1,
-  maxMarks: 1
+  maxMarks: 1,
+  encoding: {
+    codeSize: 1,
+    maxSize: 1,
+    cryptogramCount: 1
+  }
 };
 
 const _getEncodingTypes = (cvr: CastVoteRecord, ballots: Ballot[]) => {

diff --git a/lib/av_client/crypto/vote_converter.ts b/lib/av_client/crypto/vote_converter.ts
@@ -24,8 +24,7 @@ const VOTE_ENCODING_TYPE = Object.freeze({
 const getEncodingTypeFromMarkingType = (markingType: MarkingType) => {
   const { minMarks, maxMarks } = markingType;
 
-  if(markingType.style === "regular" &&
-    minMarks === 1 &&
+  if(minMarks === 1 &&
     maxMarks === 1) {
     return VOTE_ENCODING_TYPE.TEXT_UTF8
   }

diff --git a/lib/av_client/types.ts b/lib/av_client/types.ts
@@ -70,6 +70,10 @@ export interface Option {
   title: LocalString;
   subtitle: LocalString;
   description: LocalString;
+  writeIn?: {
+    maxSize: number
+    encoding: 'utf8'
+  }
 }
 
 export interface LocalString {
@@ -261,10 +265,13 @@ export type ContestConfig = {
 }
 
 export type MarkingType = {
-  style: string
-  codeSize: number
   minMarks: number
   maxMarks: number
+  encoding: {
+    codeSize: 1 | 2
+    maxSize: number
+    cryptogramCount: number
+  }
 }
 
 export interface ElectionConfig {

diff --git a/lib/av_verifier.ts b/lib/av_verifier.ts
@@ -3,7 +3,7 @@ import { CAST_REQUEST_ITEM, MAX_POLL_ATTEMPTS, POLLING_INTERVAL_MS, SPOIL_REQUES
 import { randomKeyPair } from './av_client/generate_key_pair';
 import { signPayload } from './av_client/sign';
 import { decrypt } from './av_client/decrypt_vote';
-import { VerifierItem, BoardCommitmentOpeningItem, VoterCommitmentOpeningItem, BallotCryptogramItem, ElectionConfig, ContestMap } from './av_client/types';
+import { VerifierItem, BoardCommitmentOpeningItem, VoterCommitmentOpeningItem, BallotCryptogramItem, ElectionConfig, ContestMap, MarkingType } from './av_client/types';
 import { hexToShortCode, shortCodeToHex } from './av_client/short_codes';
 
 import {
@@ -103,11 +103,14 @@ export class AVVerifier {
     validateCommmitmentOpening(boardCommitmentOpening, this.boardCommitment, 'Board commitment not valid')
     validateCommmitmentOpening(voterCommitmentOpening, this.voterCommitment, 'Voter commitment not valid')
 
-    const defaultMarkingType = {
-      style: "regular",
-      codeSize: 1,
+    const defaultMarkingType: MarkingType = {
       minMarks: 1,
-      maxMarks: 1
+      maxMarks: 1,
+      encoding: {
+        codeSize: 1,
+        maxSize: 1,
+        cryptogramCount: 1
+      }
     }
 
     return decrypt(

diff --git a/test/cvr_validation.test.ts b/test/cvr_validation.test.ts
@@ -1,17 +1,22 @@
 import { validateCvr } from '../lib/av_client/cvr_validation';
-import { Option } from '../lib/av_client/types';
+import { MarkingType, Option } from '../lib/av_client/types';
 import { expect } from 'chai';
 
+const markingType: MarkingType = {
+  minMarks: 1,
+  maxMarks: 1,
+  encoding: {
+    codeSize: 1,
+    maxSize: 1,
+    cryptogramCount: 1
+  }
+}
+
 const template = {
   vote_encoding_type: 0,
   description: {},
   write_in: false,
-  markingType: {
-    style: "regular",
-    codeSize: 1,
-    minMarks: 1,
-    maxMarks: 1
-  },
+  markingType: markingType,
   resultType: {
     name: "Something"
   },

diff --git a/test/verifier/decrypt_ballot.test.ts b/test/verifier/decrypt_ballot.test.ts
@@ -1,14 +1,17 @@
 import { decrypt } from "../../lib/av_client/decrypt_vote";
-import { ContestConfigMap } from "../../lib/av_client/types";
+import { ContestConfigMap, MarkingType } from "../../lib/av_client/types";
 import { expect } from 'chai';
 const contestConfig : ContestConfigMap = {
   "contest ref 1": {
       "reference": "contest ref 1",
       "markingType": {
-          "style": "regular",
-          "codeSize": 1,
           "minMarks": 1,
-          "maxMarks": 1
+          "maxMarks": 1,
+          "encoding": {
+            "codeSize": 1,
+            "maxSize": 1,
+            "cryptogramCount": 1,
+          }
       },
       "options": [
           {
@@ -77,11 +80,14 @@ const voterCommitmentOpening = {
   }
 }
 
-const defaultMarkingType = {
-  style: "regular",
-  codeSize: 1,
+const defaultMarkingType: MarkingType = {
   minMarks: 1,
-  maxMarks: 1
+  maxMarks: 1,
+  encoding: {
+    codeSize: 1,
+    maxSize: 1,
+    cryptogramCount: 1
+  }
 }