From 7ee1eaaacd31f7c7cadc686a27fb6e520f93b889 Mon Sep 17 00:00:00 2001
From: Hector Sanjuan <code@hector.link>
Date: Tue, 19 Nov 2024 13:44:58 +0100
Subject: [PATCH] core/routing: Split ContentRouting interface

The ContentRouting interface does too much. One can think of systems that only
Provide, and systems that only FindProviders.

Therefore I am proposing to split it further. While this can be done on
user-code, core/routing interfaces are canonical and it is better to use
interfaces coming from here.

As someone said: the best interface is that which does as little as possible.
---
 core/routing/routing.go | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/core/routing/routing.go b/core/routing/routing.go
index b995b052b9..bb8de71541 100644
--- a/core/routing/routing.go
+++ b/core/routing/routing.go
@@ -18,17 +18,18 @@ var ErrNotFound = errors.New("routing: not found")
 // type/operation.
 var ErrNotSupported = errors.New("routing: operation or key not supported")
 
-// ContentRouting is a value provider layer of indirection. It is used to find
-// information about who has what content.
-//
-// Content is identified by CID (content identifier), which encodes a hash
-// of the identified content in a future-proof manner.
-type ContentRouting interface {
+// ContentProviding is able to announce where to find content on the Routing
+// system.
+type ContentProviding interface {
 	// Provide adds the given cid to the content routing system. If 'true' is
 	// passed, it also announces it, otherwise it is just kept in the local
 	// accounting of which objects are being provided.
 	Provide(context.Context, cid.Cid, bool) error
+}
 
+// ContentDiscovery is able to retrieve providers for a given CID using
+// the Routing system.
+type ContentDiscovery interface {
 	// Search for peers who are able to provide a given key
 	//
 	// When count is 0, this method will return an unbounded number of
@@ -36,6 +37,16 @@ type ContentRouting interface {
 	FindProvidersAsync(context.Context, cid.Cid, int) <-chan peer.AddrInfo
 }
 
+// ContentRouting is a value provider layer of indirection. It is used to find
+// information about who has what content.
+//
+// Content is identified by CID (content identifier), which encodes a hash
+// of the identified content in a future-proof manner.
+type ContentRouting interface {
+	ContentProviding
+	ContentDiscovery
+}
+
 // PeerRouting is a way to find address information about certain peers.
 // This can be implemented by a simple lookup table, a tracking server,
 // or even a DHT.