Merge pull request #94 from perun-network/93-simplify-eventsub

Merge EventSub.{ReadAll|ReadFuture} into Read

Author: matthiasgeihs

backend/ethereum/channel/funder.go

@@ -264,7 +264,7 @@ func (f *Funder) waitForFundingConfirmation(ctx context.Context, request channel
 	defer sub.Close()
 	// Read from the sub.
 	go func() {
-		subErr <- sub.ReadAll(ctx, deposited)
+		subErr <- sub.Read(ctx, deposited)
 	}()
 
 	// The allocation that all participants agreed on.

backend/ethereum/subscription/eventsub.go

@@ -106,10 +106,10 @@ func calcStartBlock(ctx context.Context, chain ethereum.ChainReader, pastBlocks
 	return current.Number.Uint64() - pastBlocks, nil
 }
 
-// ReadAll reads all past and future events into `sink`.
+// Read reads all past and future events into `sink`.
 // Can be aborted by cancelling `ctx` or `Close()`.
 // It is possible that the same event is read more than once.
-func (s *EventSub) ReadAll(ctx context.Context, sink chan<- *Event) error {
+func (s *EventSub) Read(ctx context.Context, sink chan<- *Event) error {
 	// First read into the past.
 	if err := s.readPast(ctx, sink); err != nil {
 		return errors.WithMessage(err, "reading logs")
@@ -128,13 +128,6 @@ func (s *EventSub) ReadPast(ctx context.Context, sink chan<- *Event) error {
 	return errors.WithMessage(s.readPast(ctx, sink), "reading logs")
 }
 
-// ReadFuture reads all future events into `sink`.
-// Can be aborted by cancelling `ctx` or `Close()`.
-// It is possible that the same event is read more than once.
-func (s *EventSub) ReadFuture(ctx context.Context, sink chan<- *Event) error {
-	return errors.WithMessage(s.readFuture(ctx, sink), "reading logs")
-}
-
 func (s *EventSub) readPast(ctx context.Context, sink chan<- *Event) error {
 	var logs []types.Log
 	// Two read loops are needed if the event sub is closed before all events

backend/ethereum/subscription/eventsub_test.go

@@ -100,7 +100,7 @@ func TestEventSub(t *testing.T) {
 	require.NoError(t, err)
 	go ct.Stage("sub", func(t pkgtest.ConcT) {
 		defer close(sink)
-		require.NoError(t, sub.ReadAll(context.Background(), sink))
+		require.NoError(t, sub.Read(context.Background(), sink))
 	})
 
 	go ct.Stage("receiver", func(t pkgtest.ConcT) {
@@ -181,7 +181,7 @@ func TestEventSub_Filter(t *testing.T) {
 	require.NoError(t, err)
 	go ct.Stage("sub", func(t pkgtest.ConcT) {
 		defer close(sink)
-		require.NoError(t, sub.ReadAll(context.Background(), sink))
+		require.NoError(t, sub.Read(context.Background(), sink))
 	})
 
 	// Receive 1 event.