feat(routing): Delegated Routing

CHANGELOG.md

@@ -1,4 +1,34 @@
-# go-ipfs changelog
+# Kubo changelog
+
+## v0.14.0 TBD
+
+### Overview
+
+Below is an outline of all that is in this release, so you get a sense of all that's included.
+
+- [🔦 Highlights](#---highlights)
+  * [🛣️ Delegated Routing](#---Delegated-Routing)
+
+### 🔦 Highlights
+
+#### 🛣️ Delegated Routing
+
+Content routing is the a term used to describe the problem of finding providers for a given piece of content.
+If you have a hash, or CID of some data, how do you find who has it?
+In IPFS, until now, only a DHT was used as a decentralized answer to content routing.
+Now, content routing can be handled by clients implementing the [Reframe protocol](https://github.com/ipfs/specs/blob/main/REFRAME.md).
+
+Example configuration usage using the [Filecoin Network Indexer](https://docs.cid.contact/filecoin-network-indexer/overview):
+
+```
+ipfs config Routing.Routers.DevCidContact --json '{
+  "Type": "reframe",
+  "Parameters": {
+    "Endpoint": "https://cid.contact/reframe"
+  }
+}'
+
+```
 
 ## v0.13.1 2022-07-06
 

cmd/ipfs/daemon.go

@@ -400,10 +400,7 @@ func daemonFunc(req *cmds.Request, re cmds.ResponseEmitter, env cmds.Environment
 
 	routingOption, _ := req.Options[routingOptionKwd].(string)
 	if routingOption == routingOptionDefaultKwd {
-		routingOption = cfg.Routing.Type
-		if routingOption == "" {
-			routingOption = routingOptionDHTKwd
-		}
+		routingOption = cfg.Routing.Type.WithDefault(routingOptionDHTKwd)
 	}
 	switch routingOption {
 	case routingOptionSupernodeKwd:

config/init.go

@@ -48,7 +48,7 @@ func InitWithIdentity(identity Identity) (*Config, error) {
 		},
 
 		Routing: Routing{
-			Type: "dht",
+			Type: NewOptionalString("dht"),
 		},
 
 		// setup the node mount points.

config/profile.go

@@ -174,7 +174,7 @@ functionality - performance of content discovery and data
 fetching may be degraded.
 `,
 		Transform: func(c *Config) error {
-			c.Routing.Type = "dhtclient"
+			c.Routing.Type = NewOptionalString("dhtclient")
 			c.AutoNAT.ServiceMode = AutoNATServiceDisabled
 			c.Reprovider.Interval = "0"
 

config/routing.go

@@ -5,5 +5,40 @@ type Routing struct {
 	// Type sets default daemon routing mode.
 	//
 	// Can be one of "dht", "dhtclient", "dhtserver", "none", or unset.
+	Type *OptionalString `json:",omitempty"`
+
+	Routers map[string]Router
+}
+
+type Router struct {
+
+	// Currenly only supported Type is "reframe".
+	// Reframe type allows to add other resolvers using the Reframe spec:
+	// https://github.com/ipfs/specs/blob/master/REFRAME.md
+	// In the future we will support "dht" and other Types here.
 	Type string
+
+	Enabled Flag `json:",omitempty"`
+
+	// Parameters are extra configuration that this router might need.
+	// A common one for reframe router is "Endpoint".
+	Parameters map[string]string
 }
+
+// Type is the routing type.
+// Depending of the type we need to instantiate different Routing implementations.
+type RouterType string
+
+const (
+	RouterTypeReframe RouterType = "reframe"
+)
+
+type RouterParam string
+
+const (
+	// RouterParamEndpoint is the URL where the routing implementation will point to get the information.
+	// Usually used for reframe Routers.
+	RouterParamEndpoint RouterParam = "Endpoint"
+
+	RouterParamPriority RouterParam = "Priority"
+)

config/types.go

@@ -321,6 +321,11 @@ type OptionalString struct {
 	value *string
 }
 
+// NewOptionalString returns an OptionalString from a string
+func NewOptionalString(s string) *OptionalString {
+	return &OptionalString{value: &s}
+}
+
 // WithDefault resolves the integer with the given default.
 func (p *OptionalString) WithDefault(defaultValue string) (value string) {
 	if p == nil || p.value == nil {

core/commands/commands_test.go

@@ -119,6 +119,12 @@ func TestCommands(t *testing.T) {
 		"/dht/provide",
 		"/dht/put",
 		"/dht/query",
+		"/routing",
+		"/routing/put",
+		"/routing/get",
+		"/routing/findpeer",
+		"/routing/findprovs",
+		"/routing/provide",
 		"/diag",
 		"/diag/cmds",
 		"/diag/cmds/clear",