Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change thresholds for flip report committee #785

Merged
merged 1 commit into from
Aug 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions config/consensus.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ type ConsensusConf struct {
EnableValidationSharding bool
ChangeKillTxValidation bool
IncreaseGodInvitesLimit bool
FixSmallReportCommittee bool
}

type ConsensusVerson uint16
Expand Down Expand Up @@ -166,6 +167,7 @@ func ApplyConsensusVersion(ver ConsensusVerson, cfg *ConsensusConf) {
cfg.EnableValidationSharding = true
cfg.ChangeKillTxValidation = true
cfg.IncreaseGodInvitesLimit = true
cfg.FixSmallReportCommittee = true
cfg.Version = ConsensusV6
cfg.MigrationTimeout = 0
cfg.GenerateGenesisAfterUpgrade = true
Expand Down
4 changes: 2 additions & 2 deletions core/ceremony/ceremony.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ func NewValidationCeremony(appState *appstate.AppState, bus eventbus.Bus, flippe
func (vc *ValidationCeremony) Initialize(currentBlock *types.Block) {
vc.epochDb = database.NewEpochDb(vc.db, vc.appState.State.Epoch())
vc.epoch = vc.appState.State.Epoch()
vc.qualification = NewQualification(vc.epochDb)
vc.qualification = NewQualification(vc.config, vc.epochDb)
_ = vc.bus.Subscribe(events.AddBlockEventID,
func(e eventbus.Event) {
newBlockEvent := e.(*events.NewBlockEvent)
Expand Down Expand Up @@ -355,7 +355,7 @@ func (vc *ValidationCeremony) completeEpoch() {
vc.epochDb = database.NewEpochDb(vc.db, vc.appState.State.Epoch())
vc.epoch = vc.appState.State.Epoch()

vc.qualification = NewQualification(vc.epochDb)
vc.qualification = NewQualification(vc.config, vc.epochDb)
vc.flipper.Clear()
vc.keysPool.Clear()
vc.appState.EvidenceMap.Clear()
Expand Down
24 changes: 21 additions & 3 deletions core/ceremony/qualification.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"github.com/idena-network/idena-go/blockchain/types"
"github.com/idena-network/idena-go/common"
"github.com/idena-network/idena-go/common/math"
"github.com/idena-network/idena-go/config"
"github.com/idena-network/idena-go/crypto"
"github.com/idena-network/idena-go/crypto/vrf"
"github.com/idena-network/idena-go/database"
Expand All @@ -16,6 +17,7 @@ import (
)

type qualification struct {
config *config.Config
shortAnswers map[common.Address][]byte
longAnswers map[common.Address][]byte
epochDb *database.EpochDb
Expand All @@ -24,8 +26,9 @@ type qualification struct {
lock sync.RWMutex
}

func NewQualification(epochDb *database.EpochDb) *qualification {
func NewQualification(config *config.Config, epochDb *database.EpochDb) *qualification {
return &qualification{
config: config,
epochDb: epochDb,
log: log.New(),
shortAnswers: make(map[common.Address][]byte),
Expand Down Expand Up @@ -141,7 +144,7 @@ func (q *qualification) qualifyFlips(totalFlipsCount uint, candidates []*candida
result := make([]FlipQualification, totalFlipsCount)

for flipIdx := 0; flipIdx < len(data); flipIdx++ {
result[flipIdx] = qualifyOneFlip(data[flipIdx].answers, reportersToReward.getFlipReportsCount(flipIdx), data[flipIdx].totalGrade, data[flipIdx].gradesCount)
result[flipIdx] = q.qualifyOneFlip(data[flipIdx].answers, reportersToReward.getFlipReportsCount(flipIdx), data[flipIdx].totalGrade, data[flipIdx].gradesCount)
if result[flipIdx].grade != types.GradeReported {
reportersToReward.deleteFlip(flipIdx)
}
Expand Down Expand Up @@ -292,10 +295,25 @@ func getAnswersCount(a []types.Answer) (left uint, right uint, none uint) {
return left, right, none
}

func qualifyOneFlip(answers []types.Answer, reportsCount int, totalGrade int, gradesCount int) FlipQualification {
func (q *qualification) qualifyOneFlip(answers []types.Answer, reportsCount int, totalGrade int, gradesCount int) FlipQualification {
left, right, none := getAnswersCount(answers)
totalAnswersCount := float32(len(answers))

reported := float32(reportsCount)/float32(len(answers)) > 0.5
if q.config.Consensus.FixSmallReportCommittee {
reported = false
switch len(answers) {
case 1, 2, 3:
reported = reportsCount >= len(answers)
case 4:
reported = reportsCount >= 3
case 5:
reported = reportsCount >= 4
default:
reported = float32(reportsCount)/float32(len(answers)) > 0.5
}
}

graded := float32(gradesCount)/float32(len(answers)) > 0.33
var grade types.Grade
switch {
Expand Down
80 changes: 62 additions & 18 deletions core/ceremony/qualification_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"github.com/idena-network/idena-go/blockchain/attachments"
"github.com/idena-network/idena-go/blockchain/types"
"github.com/idena-network/idena-go/common"
"github.com/idena-network/idena-go/config"
"github.com/idena-network/idena-go/crypto"
"github.com/idena-network/idena-go/crypto/ecies"
"github.com/idena-network/idena-go/crypto/vrf/p256"
Expand All @@ -31,90 +32,117 @@ func Test_getAnswersCount(t *testing.T) {

func Test_qualifyOneFlip(t *testing.T) {
require := require.New(t)

cfg := &config.Config{
Consensus: config.ConsensusVersions[config.ConsensusV6],
}
qual := &qualification{config: cfg}
ans := fillArray(6, 1, 1)
q := qualifyOneFlip(ans, 4, 18, 4)
q := qual.qualifyOneFlip(ans, 4, 18, 4)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeA, q.grade)

ans = fillArray(6, 0, 0)
q = qualifyOneFlip(ans, 2, 6, 2)
q = qual.qualifyOneFlip(ans, 2, 6, 2)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeC, q.grade)

ans = fillArray(7, 0, 0)
q = qualifyOneFlip(ans, 2, 8, 2)
q = qual.qualifyOneFlip(ans, 2, 8, 2)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(7, 0, 0)
q = qualifyOneFlip(ans, 3, 12, 3)
q = qual.qualifyOneFlip(ans, 3, 12, 3)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeB, q.grade)

ans = fillArray(6, 1, 1)
q = qualifyOneFlip(ans, 4, 13, 3)
q = qual.qualifyOneFlip(ans, 4, 13, 3)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeB, q.grade)

ans = fillArray(6, 1, 1)
q = qualifyOneFlip(ans, 4, 12, 4)
q = qual.qualifyOneFlip(ans, 4, 12, 4)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeC, q.grade)

ans = fillArray(6, 1, 1)
q = qualifyOneFlip(ans, 4, 8, 4)
q = qual.qualifyOneFlip(ans, 4, 8, 4)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(6, 1, 1)
q = qualifyOneFlip(ans, 5, 6, 3)
q = qual.qualifyOneFlip(ans, 5, 6, 3)
require.Equal(Qualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeReported, q.grade)

ans = fillArray(25, 75, 0)
q = qualifyOneFlip(ans, 0, 0, 0)
q = qual.qualifyOneFlip(ans, 0, 0, 0)
require.Equal(Qualified, q.status)
require.Equal(types.Right, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(0, 10, 0)
q = qualifyOneFlip(ans, 0, 0, 0)
q = qual.qualifyOneFlip(ans, 0, 0, 0)
require.Equal(Qualified, q.status)
require.Equal(types.Right, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(15, 3, 4)
q = qualifyOneFlip(ans, 0, 0, 0)
q = qual.qualifyOneFlip(ans, 0, 0, 0)
require.Equal(WeaklyQualified, q.status)
require.Equal(types.Left, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(30, 66, 4)
q = qualifyOneFlip(ans, 0, 0, 0)
q = qual.qualifyOneFlip(ans, 0, 0, 0)
require.Equal(WeaklyQualified, q.status)
require.Equal(types.Right, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(4, 4, 4)
q = qualifyOneFlip(ans, 0, 0, 0)
q = qual.qualifyOneFlip(ans, 0, 0, 0)
require.Equal(NotQualified, q.status)
require.Equal(types.None, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(1, 2, 10)
q = qualifyOneFlip(ans, 0, 0, 0)
q = qual.qualifyOneFlip(ans, 0, 0, 0)
require.Equal(QualifiedByNone, q.status)
require.Equal(types.None, q.answer)
require.Equal(types.GradeD, q.grade)

ans = fillArray(1, 2, 00)
q = qual.qualifyOneFlip(ans, 3, 0, 0)
require.Equal(types.GradeReported, q.grade)

ans = fillArray(1, 2, 00)
q = qual.qualifyOneFlip(ans, 2, 0, 0)
require.NotEqual(types.GradeReported, q.grade)

ans = fillArray(2, 2, 00)
q = qual.qualifyOneFlip(ans, 3, 0, 0)
require.Equal(types.GradeReported, q.grade)

ans = fillArray(3, 2, 00)
q = qual.qualifyOneFlip(ans, 3, 0, 0)
require.NotEqual(types.GradeReported, q.grade)

ans = fillArray(3, 2, 00)
q = qual.qualifyOneFlip(ans, 4, 0, 0)
require.Equal(types.GradeReported, q.grade)

ans = fillArray(3, 3, 00)
q = qual.qualifyOneFlip(ans, 4, 0, 0)
require.Equal(types.GradeReported, q.grade)
}

func Test_getFlipStatusForCandidate(t *testing.T) {
Expand Down Expand Up @@ -347,12 +375,14 @@ func TestQualification_qualifyFlips(t *testing.T) {
addr1 := tests.GetRandAddr()
addr2 := tests.GetRandAddr()
addr3 := tests.GetRandAddr()
addr4 := tests.GetRandAddr()
candidates := []*candidate{
{Address: addrWithIgnoredReports},
{Address: addrWithoutReports},
{Address: addr1},
{Address: addr2},
{Address: addr3},
{Address: addr4},
}
reportedFlipIdx := 5
flipsPerCandidate := [][]int{
Expand All @@ -361,6 +391,7 @@ func TestQualification_qualifyFlips(t *testing.T) {
{reportedFlipIdx, 6, 7, 8, 9, 10},
{reportedFlipIdx, 6, 7, 8, 9, 10},
{reportedFlipIdx, 6, 7},
{reportedFlipIdx, 6, 7},
}

key, _ := crypto.GenerateKey()
Expand Down Expand Up @@ -426,13 +457,26 @@ func TestQualification_qualifyFlips(t *testing.T) {
long4.Grade(2, types.GradeB)
longAttachment4 := attachments.CreateLongAnswerAttachment(long4.Bytes(), nil, nil, ecies.ImportECDSA(key))

long5 := types.NewAnswers(uint(len(flipsPerCandidate[5])))
long5.Left(0)
long5.Grade(0, types.GradeReported)
long5.Left(1)
long5.Grade(1, types.GradeA)
long5.Right(2)
long5.Grade(2, types.GradeB)
longAttachment5 := attachments.CreateLongAnswerAttachment(long5.Bytes(), nil, nil, ecies.ImportECDSA(key))

q := qualification{
longAnswers: map[common.Address][]byte{
addrWithIgnoredReports: longAttachment0,
addrWithoutReports: longAttachment1,
addr1: longAttachment2,
addr2: longAttachment3,
addr3: longAttachment4,
addr4: longAttachment5,
},
config: &config.Config{
Consensus: config.ConsensusVersions[config.ConsensusV6],
},
}

Expand Down Expand Up @@ -461,9 +505,9 @@ func TestQualification_qualifyFlips(t *testing.T) {
require.Equal(t, types.Right, flipQualifications[9].answer)
require.Equal(t, Qualified, flipQualifications[9].status)

require.Equal(t, 3, len(reportersToReward.reportersByAddr))
require.Equal(t, 4, len(reportersToReward.reportersByAddr))

require.Equal(t, 3, len(reportersToReward.reportedFlipsByReporter))
require.Equal(t, 4, len(reportersToReward.reportedFlipsByReporter))
require.Equal(t, 1, len(reportersToReward.reportedFlipsByReporter[addr1]))
_, ok := reportersToReward.reportedFlipsByReporter[addr1][reportedFlipIdx]
require.True(t, ok)
Expand All @@ -475,7 +519,7 @@ func TestQualification_qualifyFlips(t *testing.T) {
require.True(t, ok)

require.Equal(t, 1, len(reportersToReward.reportersByFlip))
require.Equal(t, 3, len(reportersToReward.reportersByFlip[reportedFlipIdx]))
require.Equal(t, 4, len(reportersToReward.reportersByFlip[reportedFlipIdx]))
require.NotNil(t, reportersToReward.reportersByFlip[reportedFlipIdx][addr1])
require.NotNil(t, reportersToReward.reportersByFlip[reportedFlipIdx][addr2])
require.NotNil(t, reportersToReward.reportersByFlip[reportedFlipIdx][addr3])
Expand Down