Update Comm Method Names (#181)

* update comm methods

* update name

* Update README.md

Signed-off-by: Sam Liokumovich <65994425+samliok@users.noreply.github.com>

---------

Signed-off-by: Sam Liokumovich <65994425+samliok@users.noreply.github.com>

Author: samliok

README.md

@@ -507,11 +507,11 @@ which also can be configured on an epoch basis, is defined:
 ```go
 type Communication interface {
 
-    // ListNodes returns all nodes known to the application.
-    ListNodes() []NodeID
+    // Nodes returns all nodes known to the application.
+    Nodes() []NodeID
 
-    // SendMessage sends a message to the given destination node
-    SendMessage(msg Message, destination NodeID)
+    // Send sends a message to the given destination node
+    Send(msg Message, destination NodeID)
 
     // Broadcast broadcasts the given message to all nodes 
     Broadcast(msg Message)
@@ -721,9 +721,3 @@ BlockResponse {
   block Block
 }
 ```
-
-
-
-
-
-

api.go

@@ -54,11 +54,11 @@ type Storage interface {
 
 type Communication interface {
 
-	// ListNodes returns all nodes known to the application.
-	ListNodes() []NodeID
+	// Nodes returns all nodes known to the application.
+	Nodes() []NodeID
 
-	// SendMessage sends a message to the given destination node
-	SendMessage(msg *Message, destination NodeID)
+	// Send sends a message to the given destination node
+	Send(msg *Message, destination NodeID)
 
 	// Broadcast broadcasts the given message to all nodes.
 	// Does not send it to yourself.

epoch.go

@@ -173,7 +173,7 @@ func (e *Epoch) init() error {
 	e.monitor = NewMonitor(e.StartTime, e.Logger)
 	e.cancelWaitForBlockNotarization = func() {}
 	e.finishCtx, e.finishFn = context.WithCancel(context.Background())
-	e.nodes = e.Comm.ListNodes()
+	e.nodes = e.Comm.Nodes()
 	e.quorumSize = Quorum(len(e.nodes))
 	e.rounds = make(map[uint64]*Round)
 	e.maxRoundWindow = DefaultMaxRoundWindow
@@ -706,7 +706,7 @@ func (e *Epoch) maybeSendNotarizationOrFinalization(to NodeID, round uint64) {
 		msg := &Message{
 			Finalization: r.finalization,
 		}
-		e.Comm.SendMessage(msg, to)
+		e.Comm.Send(msg, to)
 		return
 	}
 
@@ -715,7 +715,7 @@ func (e *Epoch) maybeSendNotarizationOrFinalization(to NodeID, round uint64) {
 		msg := &Message{
 			Notarization: r.notarization,
 		}
-		e.Comm.SendMessage(msg, to)
+		e.Comm.Send(msg, to)
 		return
 	}
 }
@@ -2422,7 +2422,7 @@ func (e *Epoch) handleReplicationRequest(req *ReplicationRequest, from NodeID) e
 
 	response.Data = data
 	msg := &Message{VerifiedReplicationResponse: response}
-	e.Comm.SendMessage(msg, from)
+	e.Comm.Send(msg, from)
 	return nil
 }
 

epoch_failover_test.go

@@ -780,11 +780,11 @@ func newRebroadcastComm(nodes []NodeID) *rebroadcastComm {
 	}
 }
 
-func (r *rebroadcastComm) ListNodes() []NodeID {
+func (r *rebroadcastComm) Nodes() []NodeID {
 	return r.nodes
 }
 
-func (r *rebroadcastComm) SendMessage(*Message, NodeID) {
+func (r *rebroadcastComm) Send(*Message, NodeID) {
 
 }
 
@@ -887,7 +887,7 @@ func runCrashAndRestartExecution(t *testing.T, e *Epoch, bb *testBlockBuilder, w
 	cloneWAL := wal.Clone()
 	cloneStorage := storage.Clone()
 
-	nodes := e.Comm.ListNodes()
+	nodes := e.Comm.Nodes()
 
 	// Clone the block builder
 	bbAfterCrash := &testBlockBuilder{

epoch_multinode_test.go

@@ -490,11 +490,11 @@ func newTestComm(from NodeID, net *inMemNetwork, messageFilter messageFilter) *t
 	}
 }
 
-func (c *testComm) ListNodes() []NodeID {
+func (c *testComm) Nodes() []NodeID {
 	return c.net.nodes
 }
 
-func (c *testComm) SendMessage(msg *Message, destination NodeID) {
+func (c *testComm) Send(msg *Message, destination NodeID) {
 	if !c.isMessagePermitted(msg, destination) {
 		return
 	}

epoch_test.go

@@ -151,7 +151,7 @@ func TestEpochIndexFinalization(t *testing.T) {
 	// when we receive that finalization, we should commit the rest of the finalizations for seqs
 	// 1 & 2
 
-	finalization, _ := newFinalizationRecord(t, conf.Logger, conf.SignatureAggregator, firstBlock, e.Comm.ListNodes())
+	finalization, _ := newFinalizationRecord(t, conf.Logger, conf.SignatureAggregator, firstBlock, e.Comm.Nodes())
 	injectTestFinalization(t, e, &finalization, nodes[1])
 
 	storage.waitForBlockCommit(2)
@@ -523,10 +523,10 @@ func TestEpochStartedTwice(t *testing.T) {
 }
 
 func advanceRoundFromEmpty(t *testing.T, e *Epoch) {
-	leader := LeaderForRound(e.Comm.ListNodes(), e.Metadata().Round)
+	leader := LeaderForRound(e.Comm.Nodes(), e.Metadata().Round)
 	require.False(t, e.ID.Equals(leader), "epoch cannot be the leader for the empty round")
 
-	emptyNote := newEmptyNotarization(e.Comm.ListNodes(), e.Metadata().Round, e.Metadata().Seq)
+	emptyNote := newEmptyNotarization(e.Comm.Nodes(), e.Metadata().Round, e.Metadata().Seq)
 	err := e.HandleMessage(&Message{
 		EmptyNotarization: emptyNote,
 	}, leader)
@@ -555,7 +555,7 @@ func notarizeAndFinalizeRound(t *testing.T, e *Epoch, bb *testBlockBuilder) (Ver
 func advanceRound(t *testing.T, e *Epoch, bb *testBlockBuilder, notarize bool, finalize bool) (VerifiedBlock, *Notarization) {
 	require.True(t, notarize || finalize, "must either notarize or finalize a round to advance")
 	nextSeqToCommit := e.Storage.Height()
-	nodes := e.Comm.ListNodes()
+	nodes := e.Comm.Nodes()
 	quorum := Quorum(len(nodes))
 	// leader is the proposer of the new block for the given round
 	leader := LeaderForRound(nodes, e.Metadata().Round)
@@ -1288,11 +1288,11 @@ func (t *testVerifier) Verify(_ []byte, _ []byte, _ NodeID) error {
 
 type noopComm []NodeID
 
-func (n noopComm) ListNodes() []NodeID {
+func (n noopComm) Nodes() []NodeID {
 	return n
 }
 
-func (n noopComm) SendMessage(*Message, NodeID) {
+func (n noopComm) Send(*Message, NodeID) {
 
 }
 
@@ -1314,7 +1314,7 @@ func NewListenerComm(nodeIDs []NodeID) *listnerComm {
 	}
 }
 
-func (b *listnerComm) SendMessage(msg *Message, id NodeID) {
+func (b *listnerComm) Send(msg *Message, id NodeID) {
 	b.in <- msg
 }
 

replication.go

@@ -69,7 +69,7 @@ func NewReplicationState(logger Logger, comm Communication, id NodeID, maxRoundW
 		id:                   id,
 		maxRoundWindow:       maxRoundWindow,
 		receivedQuorumRounds: make(map[uint64]QuorumRound),
-		timeoutHandler:       NewTimeoutHandler(logger, start, comm.ListNodes()),
+		timeoutHandler:       NewTimeoutHandler(logger, start, comm.Nodes()),
 	}
 }
 
@@ -152,7 +152,7 @@ func (r *ReplicationState) sendRequestToNode(start uint64, end uint64, nodes []N
 
 	r.timeoutHandler.AddTask(task)
 
-	r.comm.SendMessage(msg, nodes[index])
+	r.comm.Send(msg, nodes[index])
 }
 
 func (r *ReplicationState) createReplicationTimeoutTask(start, end uint64, nodes []NodeID, index int) *TimeoutTask {