Skip to content

Commit

Permalink
chore: add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanchriswhite committed Nov 16, 2023
1 parent 9f92536 commit ab5a156
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion pkg/relayer/miner/miner.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ func (mnr *miner) MinedRelays(
ctx context.Context,
servedRelaysObs relayer.RelaysObservable,
) relayer.MinedRelaysObservable {
// TODO_IN_THIS_COMMIT: comment...
// NB: must cast back to generic observable type to use with Map.
// relayer.RelaysObervable cannot be an alias due to gomock's lack of
// support for generic types.
relaysObs := observable.Observable[*servicetypes.Relay](servedRelaysObs)

// Map servedRelaysObs to a new observable of an either type, populated with
Expand Down
4 changes: 3 additions & 1 deletion pkg/relayer/session/session.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ func NewRelayerSessions(
// network as necessary.
// It IS NOT BLOCKING as map operations run in their own goroutines.
func (rs *relayerSessionsManager) Start(ctx context.Context) {
// TODO_IN_THIS_COMMIT: comment...
// NB: must cast back to generic observable type to use with Map.
// relayer.MinedRelaysObservable cannot be an alias due to gomock's lack of
// support for generic types.
relayObs := observable.Observable[*relayer.MinedRelay](rs.relayObs)

// Map eitherMinedRelays to a new observable of an error type which is
Expand Down

0 comments on commit ab5a156

Please sign in to comment.