Skip to content

Commit

Permalink
feat(lib/grandpa): Include equivocatory nodes while creating justific…
Browse files Browse the repository at this point in the history
…ation (#1911)

* feat: include equivocatory nodes while creating just

* chore: remove unecessary error return

* chore: undo condition format

* chore: use equivocatory votes on threshold count

* chore: add unsupported subround error

* chore: remove unecessary check

* chore: remove eqv votes and use the eqv voters

* chore: remove unecessary convertion

* chore: export ErrUnsupportedSubround

* chore: improve code reading

* chore: add tests to grandpa.createJustification func

* chore: add tests to grandpa message handler files

* chore: fix ci warns

* chore: put back a condition to check enough precommits in the justification

* chore: check if the equivocatory votes are on justification

* chore: fix the fakeAuthorities format

* chore: removing parallel and uncoment Err...

* chore: adjusting the equivocatory and prevote testing

* chore: fix lint warns

* chore: address nit comments

* chore: adjust test asserts

* chore: adjust naming

* chore: mock time.Unix in tests

* chore: add test to equivocatory voters on to VerifyBlockJustification

* chore: adjust testing

* chore: check errors

* chore: changing the style to checking ok variable

* chore: fix conflicts and ignore testing lint warns

* chore: check err

* chore: fix runtime not found problems

* chore: removing unused imports
  • Loading branch information
EclesioMeloJunior authored Nov 24, 2021
1 parent facb87a commit aca86b6
Show file tree
Hide file tree
Showing 6 changed files with 599 additions and 22 deletions.
4 changes: 4 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ issues:
source: "^//go:generate "
text: "long-lines"

- text: 'G204: Subprocess launched with variable'
linters:
- gosec

# Independently from option `exclude` we use default exclude patterns,
# it can be disabled by this option. To list all
# excluded by default patterns execute `golangci-lint run --help`.
Expand Down
18 changes: 16 additions & 2 deletions lib/grandpa/grandpa.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ var (
logger = log.NewFromGlobal(log.AddContext("pkg", "grandpa"))
)

var (
ErrUnsupportedSubround = errors.New("unsupported subround")
)

// Service represents the current state of the grandpa protocol
type Service struct {
// preliminaries
Expand Down Expand Up @@ -688,7 +692,7 @@ func (s *Service) determinePreCommit() (*Vote, error) {
return &pvb, nil
}

// isFinalisable returns true is the round is finalisable, false otherwise.
// isFinalisable returns true if the round is finalisable, false otherwise.
func (s *Service) isFinalisable(round uint64) (bool, error) {
var pvb Vote
var err error
Expand Down Expand Up @@ -806,16 +810,20 @@ func (s *Service) createJustification(bfc common.Hash, stage Subround) ([]Signed
spc *sync.Map
err error
just []SignedVote
eqv map[ed25519.PublicKeyBytes][]*SignedVote
)

switch stage {
case prevote:
spc = s.prevotes
eqv = s.pvEquivocations
case precommit:
spc = s.precommits
eqv = s.pcEquivocations
default:
return nil, fmt.Errorf("%w: %s", ErrUnsupportedSubround, stage)
}

// TODO: use equivacatory votes to create justification as well (#1667)
spc.Range(func(_, value interface{}) bool {
pc := value.(*SignedVote)
var isDescendant bool
Expand All @@ -837,6 +845,12 @@ func (s *Service) createJustification(bfc common.Hash, stage Subround) ([]Signed
return nil, err
}

for _, votes := range eqv {
for _, vote := range votes {
just = append(just, *vote)
}
}

return just, nil
}

Expand Down
157 changes: 157 additions & 0 deletions lib/grandpa/grandpa_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"math/big"
"math/rand"
"sort"
"sync"
"testing"
"time"

Expand Down Expand Up @@ -1264,3 +1265,159 @@ func TestFinalRoundGaugeMetric(t *testing.T) {
gauge := ethmetrics.GetOrRegisterGauge(finalityGrandpaRoundMetrics, nil)
require.Equal(t, gauge.Value(), int64(180))
}

func TestGrandpaServiceCreateJustification_ShouldCountEquivocatoryVotes(t *testing.T) {
// setup granpda service
gs, st := newTestService(t)
now := time.Unix(1000, 0)

const previousBlocksToAdd = 9
bfcBlock := addBlocksAndReturnTheLastOne(t, st.Block, previousBlocksToAdd, now)

bfcHash := bfcBlock.Header.Hash()
bfcNumber := bfcBlock.Header.Number.Int64()

// create fake authorities
ed25519Keyring, err := keystore.NewEd25519Keyring()
require.NoError(t, err)
fakeAuthorities := []*ed25519.Keypair{
ed25519Keyring.Alice().(*ed25519.Keypair),
ed25519Keyring.Bob().(*ed25519.Keypair),
ed25519Keyring.Charlie().(*ed25519.Keypair),
ed25519Keyring.Dave().(*ed25519.Keypair),
ed25519Keyring.Eve().(*ed25519.Keypair),
ed25519Keyring.Bob().(*ed25519.Keypair), // equivocatory
ed25519Keyring.Dave().(*ed25519.Keypair), // equivocatory
}

equivocatories := make(map[ed25519.PublicKeyBytes][]*types.GrandpaSignedVote)
prevotes := &sync.Map{}

var totalLegitVotes int
// voting on
for _, v := range fakeAuthorities {
vote := &SignedVote{
AuthorityID: v.Public().(*ed25519.PublicKey).AsBytes(),
Vote: types.GrandpaVote{
Hash: bfcHash,
Number: uint32(bfcNumber),
},
}

// to simulate the real world:
// if the voter already has voted, then we remove
// previous vote and add it on the equivocatories with the new vote
previous, ok := prevotes.Load(vote.AuthorityID)
if !ok {
prevotes.Store(vote.AuthorityID, vote)
totalLegitVotes++
} else {
prevotes.Delete(vote.AuthorityID)
equivocatories[vote.AuthorityID] = []*types.GrandpaSignedVote{
previous.(*types.GrandpaSignedVote),
vote,
}
totalLegitVotes--
}
}

gs.pvEquivocations = equivocatories
gs.prevotes = prevotes

justifications, err := gs.createJustification(bfcHash, prevote)
require.NoError(t, err)

var totalEqvVotes int
// checks if the created justification contains all equivocatories votes
for eqvPubKeyBytes, expectedVotes := range equivocatories {
votesOnJustification := 0

for _, justification := range justifications {
if justification.AuthorityID == eqvPubKeyBytes {
votesOnJustification++
}
}

require.Equal(t, len(expectedVotes), votesOnJustification)
totalEqvVotes += votesOnJustification
}

require.Len(t, justifications, totalLegitVotes+totalEqvVotes)
}

// addBlocksToState test helps adding previous blocks
func addBlocksToState(t *testing.T, blockState *state.BlockState, depth int) {
t.Helper()

previousHash := blockState.BestBlockHash()

rt, err := blockState.GetRuntime(nil)
require.NoError(t, err)

head, err := blockState.BestBlockHeader()
require.NoError(t, err)

startNum := int(head.Number.Int64())

for i := startNum + 1; i <= depth; i++ {
arrivalTime := time.Now()

d, err := types.NewBabePrimaryPreDigest(0, uint64(i), [32]byte{}, [64]byte{}).ToPreRuntimeDigest()
require.NoError(t, err)
require.NotNil(t, d)
digest := types.NewDigest()
err = digest.Add(*d)
require.NoError(t, err)

block := &types.Block{
Header: types.Header{
ParentHash: previousHash,
Number: big.NewInt(int64(i)),
StateRoot: trie.EmptyHash,
Digest: digest,
},
Body: types.Body{},
}

hash := block.Header.Hash()
err = blockState.AddBlockWithArrivalTime(block, arrivalTime)
require.NoError(t, err)

blockState.StoreRuntime(hash, rt)
previousHash = hash
}
}

func addBlocksAndReturnTheLastOne(t *testing.T, blockState *state.BlockState, depth int, lastBlockArrivalTime time.Time) *types.Block {
t.Helper()
addBlocksToState(t, blockState, depth)

// create a new fake block to fake authorities commit on
previousHash := blockState.BestBlockHash()
previousHead, err := blockState.BestBlockHeader()
require.NoError(t, err)

bfcNumber := int(previousHead.Number.Int64() + 1)

d, err := types.NewBabePrimaryPreDigest(0, uint64(bfcNumber), [32]byte{}, [64]byte{}).ToPreRuntimeDigest()
require.NoError(t, err)
require.NotNil(t, d)
digest := types.NewDigest()
err = digest.Add(*d)
require.NoError(t, err)

bfcBlock := &types.Block{
Header: types.Header{
ParentHash: previousHash,
Number: big.NewInt(int64(bfcNumber)),
StateRoot: trie.EmptyHash,
Digest: digest,
},
Body: types.Body{},
}

err = blockState.AddBlockWithArrivalTime(bfcBlock, lastBlockArrivalTime)
require.NoError(t, err)

return bfcBlock
}
Loading

0 comments on commit aca86b6

Please sign in to comment.