Rename getMessagesForBlockHash to messages

ChainSafe · May 4, 2022 · 8a4d2d3 · 8a4d2d3
1 parent e484a08
commit 8a4d2d3
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/lib/grandpa/message_tracker.go b/lib/grandpa/message_tracker.go
@@ -104,7 +104,7 @@ func (t *tracker) handleBlock(b *types.Block) {
 	defer t.mapLock.Unlock()
 
 	h := b.Header.Hash()
-	vms := t.votes.getMessagesForBlockHash(h)
+	vms := t.votes.messages(h)
 	for _, v := range vms {
 		// handleMessage would never error for vote message
 		_, err := t.handler.handleMessage(v.from, v.msg)

diff --git a/lib/grandpa/message_tracker_test.go b/lib/grandpa/message_tracker_test.go
@@ -175,7 +175,7 @@ func TestMessageTracker_MapInsideMap(t *testing.T) {
 	}
 
 	hash := header.Hash()
-	messages := gs.tracker.votes.getMessagesForBlockHash(hash)
+	messages := gs.tracker.votes.messages(hash)
 	require.Empty(t, messages)
 
 	gs.keypair = kr.Alice().(*ed25519.Keypair)
@@ -217,7 +217,7 @@ func TestMessageTracker_handleTick(t *testing.T) {
 	}
 
 	// shouldn't be deleted as round in message >= grandpa round
-	require.Len(t, gs.tracker.votes.getMessagesForBlockHash(testHash), 1)
+	require.Len(t, gs.tracker.votes.messages(testHash), 1)
 
 	gs.state.round = 1
 	msg = &VoteMessage{
@@ -238,5 +238,5 @@ func TestMessageTracker_handleTick(t *testing.T) {
 	}
 
 	// should be deleted as round in message < grandpa round
-	require.Empty(t, gs.tracker.votes.getMessagesForBlockHash(testHash))
+	require.Empty(t, gs.tracker.votes.messages(testHash))
 }
diff --git a/lib/grandpa/votes_tracker.go b/lib/grandpa/votes_tracker.go
@@ -144,12 +144,12 @@ func (vt *votesTracker) delete(blockHash common.Hash) {
 	delete(vt.mapping, blockHash)
 }
 
-// getMessagesForBlockHash returns all the vote messages
+// messages returns all the vote messages
 // for a particular block hash from the tracker as a slice
 // of networkVoteMessage. There is no order in the slice.
 // It returns nil if the block hash does not exist.
-func (vt *votesTracker) getMessagesForBlockHash(
-	blockHash common.Hash) (messages []networkVoteMessage) {
+func (vt *votesTracker) messages(blockHash common.Hash) (
+	messages []networkVoteMessage) {
 	authIDToData, ok := vt.mapping[blockHash]
 	if !ok {
 		// Note authIDToData cannot be empty

diff --git a/lib/grandpa/votes_tracker_test.go b/lib/grandpa/votes_tracker_test.go
@@ -260,7 +260,7 @@ func Test_votesTracker_delete(t *testing.T) {
 	})
 }
 
-func Test_votesTracker_getMessagesForBlockHash(t *testing.T) {
+func Test_votesTracker_messages(t *testing.T) {
 	t.Parallel()
 
 	testCases := map[string]struct {
@@ -306,7 +306,7 @@ func Test_votesTracker_getMessagesForBlockHash(t *testing.T) {
 			t.Parallel()
 
 			vt := testCase.votesTracker
-			messages := vt.getMessagesForBlockHash(testCase.blockHash)
+			messages := vt.messages(testCase.blockHash)
 
 			sort.Slice(messages, func(i, j int) bool {
 				if messages[i].from == messages[j].from {