Merge pull request #191 from c4dt/fix-create-forms

Revert "@pierluca's and @jbsv's comments"

Author: PascalinDe

.github/workflows/go_test.yml

@@ -19,10 +19,9 @@ jobs:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v3
 
-# TODO: https://github.com/dedis/d-voting/issues/392
-#      - name: Run lint
-#        run: make lint
-#
+      - name: Run lint
+        run: make lint
+
       - name: Run vet
         run: make vet
 

contracts/evoting/json/forms.go

@@ -36,8 +36,8 @@ func (formFormat) Encode(ctx serde.Context, message serde.Message) ([]byte, erro
 			}
 		}
 
-		suffragias := make([]string, len(m.SuffragiaStoreKeys))
-		for i, suf := range m.SuffragiaStoreKeys {
+		suffragias := make([]string, len(m.SuffragiaIDs))
+		for i, suf := range m.SuffragiaIDs {
 			suffragias[i] = hex.EncodeToString(suf)
 		}
 
@@ -146,19 +146,19 @@ func (formFormat) Decode(ctx serde.Context, data []byte) (serde.Message, error)
 	}
 
 	return types.Form{
-		Configuration:      formJSON.Configuration,
-		FormID:             formJSON.FormID,
-		Status:             types.Status(formJSON.Status),
-		Pubkey:             pubKey,
-		BallotSize:         formJSON.BallotSize,
-		SuffragiaStoreKeys: suffragias,
-		SuffragiaHashes:    suffragiaHashes,
-		BallotCount:        formJSON.BallotCount,
-		ShuffleInstances:   shuffleInstances,
-		ShuffleThreshold:   formJSON.ShuffleThreshold,
-		PubsharesUnits:     pubSharesSubmissions,
-		DecryptedBallots:   formJSON.DecryptedBallots,
-		Roster:             roster,
+		Configuration:    formJSON.Configuration,
+		FormID:           formJSON.FormID,
+		Status:           types.Status(formJSON.Status),
+		Pubkey:           pubKey,
+		BallotSize:       formJSON.BallotSize,
+		SuffragiaIDs:     suffragias,
+		SuffragiaHashes:  suffragiaHashes,
+		BallotCount:      formJSON.BallotCount,
+		ShuffleInstances: shuffleInstances,
+		ShuffleThreshold: formJSON.ShuffleThreshold,
+		PubsharesUnits:   pubSharesSubmissions,
+		DecryptedBallots: formJSON.DecryptedBallots,
+		Roster:           roster,
 	}, nil
 }
 

contracts/evoting/mod.go

@@ -10,7 +10,6 @@ import (
 	"go.dedis.ch/dela/core/execution/native"
 	"go.dedis.ch/dela/core/ordering/cosipbft/authority"
 	"go.dedis.ch/dela/core/store"
-	"go.dedis.ch/dela/core/store/prefixed"
 	"go.dedis.ch/dela/serde"
 	"go.dedis.ch/dela/serde/json"
 
@@ -199,8 +198,6 @@ func (c Contract) Execute(snap store.Snapshot, step execution.Step) error {
 		return xerrors.Errorf("%q not found in tx arg", CmdArg)
 	}
 
-	snap = prefixed.NewSnapshot(ContractUID, snap)
-
 	switch Command(cmd) {
 	case CmdCreateForm:
 		err = c.cmd.createForm(snap, step)

contracts/evoting/types/election.go

@@ -42,11 +42,11 @@ const (
 	Canceled Status = 6
 )
 
-// BallotsPerBatch to improve performance, so that (de)serializing only touches
+// BallotsPerBlock to improve performance, so that (de)serializing only touches
 // 100 ballots at a time.
-var BallotsPerBatch = uint32(100)
+var BallotsPerBlock = uint32(100)
 
-// TestCastBallots if true, automatically fills every batch with ballots.
+// TestCastBallots if true, automatically fills every block with ballots.
 var TestCastBallots = false
 
 // formFormat contains the supported formats for the form. Right now
@@ -78,17 +78,18 @@ type Form struct {
 	// to pad smaller ballots such that all  ballots cast have the same size
 	BallotSize int
 
-	// SuffragiaStoreKeys holds a slice of storage-keys to 0 or more Suffragia.
+	// SuffragiaIDs holds a slice of IDs to slices of SuffragiaIDs.
 	// This is to optimize the time it takes to (De)serialize a Form.
-	SuffragiaStoreKeys [][]byte
+	SuffragiaIDs [][]byte
 
 	// BallotCount is the total number of ballots cast, including double
 	// ballots.
 	BallotCount uint32
 
-	// SuffragiaHashes holds a slice of hashes to all SuffragiaStoreKeys.
-	// In case a Form has also to be proven to be correct outside the nodes,
-	// the hashes are needed to prove the Suffragia are correct.
+	// SuffragiaHashes holds a slice of hashes to all SuffragiaIDs.
+	// LG: not really sure if this is needed. In case a Form has also to be
+	// proven to be correct outside the nodes, the hashes are definitely
+	// needed.
 	SuffragiaHashes [][]byte
 
 	// ShuffleInstances is all the shuffles, along with their proof and identity
@@ -203,9 +204,8 @@ func (e *Form) ChunksPerBallot() int {
 // CastVote stores the new vote in the memory.
 func (s *Form) CastVote(ctx serde.Context, st store.Snapshot, userID string, ciphervote Ciphervote) error {
 	var suff Suffragia
-	var batchID []byte
-
-	if s.BallotCount%BallotsPerBatch == 0 {
+	var blockID []byte
+	if s.BallotCount%BallotsPerBlock == 0 {
 		// Need to create a random ID for storing the ballots.
 		// H( formID | ballotcount )
 		// should be random enough, even if it's previsible.
@@ -216,43 +216,42 @@ func (s *Form) CastVote(ctx serde.Context, st store.Snapshot, userID string, cip
 		h := sha256.New()
 		h.Write(id)
 		binary.LittleEndian.PutUint32(id, s.BallotCount)
-		batchID = h.Sum(id[0:4])[:32]
-
-		err = st.Set(batchID, []byte{})
+		blockID = h.Sum(id[0:4])[:32]
+		err = st.Set(blockID, []byte{})
 		if err != nil {
-			return xerrors.Errorf("couldn't store new ballot batch: %v", err)
+			return xerrors.Errorf("couldn't store new ballot block: %v", err)
 		}
-		s.SuffragiaStoreKeys = append(s.SuffragiaStoreKeys, batchID)
+		s.SuffragiaIDs = append(s.SuffragiaIDs, blockID)
 		s.SuffragiaHashes = append(s.SuffragiaHashes, []byte{})
 	} else {
-		batchID = s.SuffragiaStoreKeys[len(s.SuffragiaStoreKeys)-1]
-		buf, err := st.Get(batchID)
+		blockID = s.SuffragiaIDs[len(s.SuffragiaIDs)-1]
+		buf, err := st.Get(blockID)
 		if err != nil {
-			return xerrors.Errorf("couldn't get ballots batch: %v", err)
+			return xerrors.Errorf("couldn't get ballots block: %v", err)
 		}
 		format := suffragiaFormat.Get(ctx.GetFormat())
 		ctx = serde.WithFactory(ctx, CiphervoteKey{}, CiphervoteFactory{})
 		msg, err := format.Decode(ctx, buf)
 		if err != nil {
-			return xerrors.Errorf("couldn't unmarshal ballots batch in cast: %v", err)
+			return xerrors.Errorf("couldn't unmarshal ballots block in cast: %v", err)
 		}
 		suff = msg.(Suffragia)
 	}
 
 	suff.CastVote(userID, ciphervote)
 	if TestCastBallots {
-		for i := uint32(1); i < BallotsPerBatch; i++ {
+		for i := uint32(1); i < BallotsPerBlock; i++ {
 			suff.CastVote(fmt.Sprintf("%s-%d", userID, i), ciphervote)
 		}
-		s.BallotCount += BallotsPerBatch - 1
+		s.BallotCount += BallotsPerBlock - 1
 	}
 	buf, err := suff.Serialize(ctx)
 	if err != nil {
-		return xerrors.Errorf("couldn't marshal ballots batch: %v", err)
+		return xerrors.Errorf("couldn't marshal ballots block: %v", err)
 	}
-	err = st.Set(batchID, buf)
+	err = st.Set(blockID, buf)
 	if err != nil {
-		xerrors.Errorf("couldn't set new ballots batch: %v", err)
+		xerrors.Errorf("couldn't set new ballots block: %v", err)
 	}
 	s.BallotCount += 1
 	return nil
@@ -264,16 +263,16 @@ func (s *Form) CastVote(ctx serde.Context, st store.Snapshot, userID string, cip
 // the latest ballot.
 func (s *Form) Suffragia(ctx serde.Context, rd store.Readable) (Suffragia, error) {
 	var suff Suffragia
-	for _, id := range s.SuffragiaStoreKeys {
+	for _, id := range s.SuffragiaIDs {
 		buf, err := rd.Get(id)
 		if err != nil {
-			return suff, xerrors.Errorf("couldn't get ballot batch: %v", err)
+			return suff, xerrors.Errorf("couldn't get ballot block: %v", err)
 		}
 		format := suffragiaFormat.Get(ctx.GetFormat())
 		ctx = serde.WithFactory(ctx, CiphervoteKey{}, CiphervoteFactory{})
 		msg, err := format.Decode(ctx, buf)
 		if err != nil {
-			return suff, xerrors.Errorf("couldn't unmarshal ballots batch in cast: %v", err)
+			return suff, xerrors.Errorf("couldn't unmarshal ballots block in cast: %v", err)
 		}
 		suffTmp := msg.(Suffragia)
 		for i, uid := range suffTmp.UserIDs {

integration/performance_test.go

@@ -45,7 +45,7 @@ func customVotesScenario(b *testing.B, stuffing bool) {
 			types.TestCastBallots = false
 		}()
 		numVotes = 10000
-		transactions = numVotes / int(types.BallotsPerBatch)
+		transactions = numVotes / int(types.BallotsPerBlock)
 	}
 
 	adminID := "I am an admin"
@@ -169,7 +169,7 @@ func customVotesScenario(b *testing.B, stuffing bool) {
 	b.Logf("Submitting shares took: %v", durationPubShares)
 	b.Logf("Decryption took: %v", durationDecrypt)
 
-	require.Len(b, form.DecryptedBallots, len(castedVotes)*int(types.BallotsPerBatch))
+	require.Len(b, form.DecryptedBallots, len(castedVotes)*int(types.BallotsPerBlock))
 
 	// There will be a lot of supplementary ballots, but at least the ones that were
 	// cast by the test should be present.

services/dkg/pedersen/handler.go

@@ -790,7 +790,7 @@ func (s *state) UnmarshalJSON(data []byte) error {
 	}
 
 	if aux.Participants != nil {
-		// TODO: https://github.com/dedis/d-voting/issues/391
+		// TODO: use addressFactory here
 		f := session.AddressFactory{}
 		var participants = make([]mino.Address, len(aux.Participants))
 		for i, partStr := range aux.Participants {

services/dkg/pedersen/handler_test.go

@@ -267,7 +267,7 @@ func TestState_MarshalJSON(t *testing.T) {
 
 	// Try with some data
 	distKey := suite.Point().Pick(suite.RandomStream())
-	// TODO: https://github.com/dedis/d-voting/issues/391
+	// TODO: use AddressFactory here
 	participants := []mino.Address{session.NewAddress("grpcs://localhost:12345"), session.NewAddress("grpcs://localhost:1234")}
 
 	s1.SetDistKey(distKey)

services/shuffle/neff/handler_test.go

@@ -54,6 +54,7 @@ func TestHandler_Stream(t *testing.T) {
 	err = handler.Stream(fake.Sender{}, receiver)
 
 	require.NoError(t, err)
+
 }
 
 func TestHandler_StartShuffle(t *testing.T) {
@@ -109,14 +110,14 @@ func TestHandler_StartShuffle(t *testing.T) {
 	err = handler.handleStartShuffle(dummyID)
 	require.EqualError(t, err, "the form must be closed: (0)")
 
-	// TODO: think how to re-enable this test
-	t.Skip("Issue 390 - Doesn't work with new form because of snap needed by Form")
+	t.Skip("Doesn't work with new form because of snap needed by Form")
 
 	Ks, Cs, pubKey := fakeKCPoints(k)
 
 	// Wrong formatted ballots:
 	form.Status = etypes.Closed
 
+	// TODO: think how to re-enable this test
 	//deleteUserFromSuffragia := func(suff *etypes.Suffragia, userID string) bool {
 	//	for i, u := range suff.UserIDs {
 	//		if u == userID {
@@ -139,8 +140,7 @@ func TestHandler_StartShuffle(t *testing.T) {
 			C: Cs[i],
 		},
 		}
-		err := form.CastVote(service.Context, snap, "dummyUser"+strconv.Itoa(i), ballot)
-		require.NoError(t, err)
+		form.CastVote(service.Context, snap, "dummyUser"+strconv.Itoa(i), ballot)
 	}
 
 	service = updateService(form, dummyID)