Previously we only used the Amino DHT for content routing and content providing.
Kubo 0.14 introduced experimental support for delegated routing using Reframe protocol. Since then, Reframe got deprecated and superseded by Routing V1 HTTP API.
Kubo 0.23.0 release added support for self-hosting Routing V1 HTTP API server.
Now we need a better way to add different routers using different protocols like Routing V1 or Amino DHT, and be able to configure them (future routing systems to come) to cover different use cases.
The actual routing implementation is not enough. Some users need to have more options when configuring the routing system. The new implementations should be able to:
- Be user-friendly and easy enough to configure, but also versatile
- Configurable Router execution order
- Delay some of the Router methods execution when they will be executed on parallel
- Configure which method of a giving router will be used
- Mark some router methods as mandatory to make the execution fails if that method fails
The Routing configuration section will contain the following keys:
Type will be still in use to avoid complexity for the user that only wants to use Kubo with the default behavior. We are going to add a new type, custom, that will use the new router systems. none type will deactivate all routers, default dht and delegated ones.
Routers will be a key-value list of routers that will be available to use. The key is the router name and the value is all the needed configurations for that router. the Type will define the routing kind. The main router types will be reframe and dht, but we will implement two special routers used to execute a set of routers in parallel or sequentially: parallel router and sequential router.
Depending on the routing type, it will use different parameters:
Params:
"Endpoint": URL endpoint implementing Reframe protocol.
Params:
"Mode": Mode used by the Amino DHT. Possible values: "server", "client", "auto""AcceleratedDHTClient": Set totrueif you want to use the experimentalDHT."PublicIPNetwork": Set totrueto create aWANAmino DHT. Set tofalseto create aLANDHT.
Params:
Routers: A list of routers that will be executed in parallel:Name:string: Name of the router. It should be one of the previously added toRouterslist.Timeout:duration: Local timeout. It accepts strings compatible with Gotime.ParseDuration(string). Time will start counting when this specific router is called, and it will stop when the router returns, or we reach the specified timeout.ExecuteAfter:duration: Providing this param will delay the execution of that router at the specified time. It accepts strings compatible with Gotime.ParseDuration(string).IgnoreErrors:bool: It will specify if that router should be ignored if an error occurred.
Timeout:duration: Global timeout. It accepts strings compatible with Gotime.ParseDuration(string).
Params:
Routers: A list of routers that will be executed in order:Name:string: Name of the router. It should be one of the previously added toRouterslist.Timeout:duration: Local timeout. It accepts strings compatible with Gotime.ParseDuration(string). Time will start counting when this specific router is called, and it will stop when the router returns, or we reach the specified timeout.IgnoreErrors:bool: It will specify if that router should be ignored if an error occurred.
Timeout:duration: Global timeout. It accepts strings compatible with Gotime.ParseDuration(string).
Methods:map will define which routers will be executed per method. The key will be the name of the method: "provide", "find-providers", "find-peers", "put-ipns", "get-ipns". All methods must be added to the list. This will make configuration discoverable giving good errors to the user if a method is missing.
The value will contain:
RouterName:string: Name of the router. It should be one of the previously added toRouterslist.
"Routing": {
"Type": "custom",
"Routers": {
"storetheindex": {
"Type": "reframe",
"Parameters": {
"Endpoint": "https://cid.contact/reframe"
}
},
"dht-lan": {
"Type": "dht",
"Parameters": {
"Mode": "server",
"PublicIPNetwork": false,
"AcceleratedDHTClient": false
}
},
"dht-wan": {
"Type": "dht",
"Parameters": {
"Mode": "auto",
"PublicIPNetwork": true,
"AcceleratedDHTClient": false
}
},
"find-providers-router": {
"Type": "parallel",
"Parameters": {
"Routers": [
{
"RouterName": "dht-lan",
"IgnoreErrors": true
},
{
"RouterName": "dht-wan"
},
{
"RouterName": "storetheindex"
}
]
}
},
"provide-router": {
"Type": "parallel",
"Parameters": {
"Routers": [
{
"RouterName": "dht-lan",
"IgnoreErrors": true
},
{
"RouterName": "dht-wan",
"ExecuteAfter": "100ms",
"Timeout": "100ms"
},
{
"RouterName": "storetheindex",
"ExecuteAfter": "100ms"
}
]
}
},
"get-ipns-router": {
"Type": "sequential",
"Parameters": {
"Routers": [
{
"RouterName": "dht-lan",
"IgnoreErrors": true
},
{
"RouterName": "dht-wan",
"Timeout": "300ms"
},
{
"RouterName": "storetheindex",
"Timeout": "300ms"
}
]
}
},
"put-ipns-router": {
"Type": "parallel",
"Parameters": {
"Routers": [
{
"RouterName": "dht-lan"
},
{
"RouterName": "dht-wan"
},
{
"RouterName": "storetheindex"
}
]
}
}
},
"Methods": {
"find-providers": {
"RouterName": "find-providers-router"
},
"provide": {
"RouterName": "provide-router"
},
"get-ipns": {
"RouterName": "get-ipns-router"
},
"put-ipns": {
"RouterName": "put-ipns-router"
}
}
}Added YAML for clarity:
---
Type: custom
Routers:
storetheindex:
Type: reframe
Parameters:
Endpoint: https://cid.contact/reframe
dht-lan:
Type: dht
Parameters:
Mode: server
PublicIPNetwork: false
AcceleratedDHTClient: false
dht-wan:
Type: dht
Parameters:
Mode: auto
PublicIPNetwork: true
AcceleratedDHTClient: false
find-providers-router:
Type: parallel
Parameters:
Routers:
- RouterName: dht-lan
IgnoreErrors: true
- RouterName: dht-wan
- RouterName: storetheindex
provide-router:
Type: parallel
Parameters:
Routers:
- RouterName: dht-lan
IgnoreErrors: true
- RouterName: dht-wan
ExecuteAfter: 100ms
Timeout: 100ms
- RouterName: storetheindex
ExecuteAfter: 100ms
get-ipns-router:
Type: sequential
Parameters:
Routers:
- RouterName: dht-lan
IgnoreErrors: true
- RouterName: dht-wan
Timeout: 300ms
- RouterName: storetheindex
Timeout: 300ms
put-ipns-router:
Type: parallel
Parameters:
Routers:
- RouterName: dht-lan
- RouterName: dht-wan
- RouterName: storetheindex
Methods:
find-providers:
RouterName: find-providers-router
provide:
RouterName: provide-router
get-ipns:
RouterName: get-ipns-router
put-ipns:
RouterName: put-ipns-router- If any of the routers fails, the output will be an error by default.
- You can use
IgnoreErrors:trueto ignore errors for a specific router output - To avoid any error at the output, you must ignore all router errors.
All routers must implement the routing.Routing interface:
type Routing interface {
ContentRouting
PeerRouting
ValueStore
Bootstrap(context.Context) error
}
All methods involved:
type Routing interface {
Provide(context.Context, cid.Cid, bool) error
FindProvidersAsync(context.Context, cid.Cid, int) <-chan peer.AddrInfo
FindPeer(context.Context, peer.ID) (peer.AddrInfo, error)
PutValue(context.Context, string, []byte, ...Option) error
GetValue(context.Context, string, ...Option) ([]byte, error)
SearchValue(context.Context, string, ...Option) (<-chan []byte, error)
Bootstrap(context.Context) error
}
We can configure which methods will be used per routing implementation. Methods names used in the configuration file will be:
Provide:"provide"FindProvidersAsync:"find-providers"FindPeer:"find-peers"PutValue:"put-ipns"GetValue,SearchValue:"get-ipns"Bootstrap: It will be always executed when needed.
We need to implement the parallel and sequential routers and stop using routinghelpers.Tiered router implementation.
Add cycle detection to avoid to user some headaches.
Also we need to implement an internal router, that will define the router used per method.
- We need to refactor how DHT routers are created to be able to use and add any amount of custom DHT routers.
- We need to add a new
customrouter type to be able to use the new routing system. - Bitswap WANT broadcasting is not included on this document, but it can be added in next iterations.
- This document will live in docs/design-notes for historical reasons and future reference.
As test fixtures we can add different use cases here and see how the configuration will look like.
"Routing": {
"Type": "custom",
"Routers": {
"dht-lan": {
"Type": "dht",
"Parameters": {
"Mode": "server",
"PublicIPNetwork": false
}
},
"dht-wan": {
"Type": "dht",
"Parameters": {
"Mode": "auto",
"PublicIPNetwork": true
}
},
"parallel-dht-strict": {
"Type": "parallel",
"Parameters": {
"Routers": [
{
"RouterName": "dht-lan"
},
{
"RouterName": "dht-wan"
}
]
}
},
"parallel-dht": {
"Type": "parallel",
"Parameters": {
"Routers": [
{
"RouterName": "dht-lan",
"IgnoreError": true
},
{
"RouterName": "dht-wan"
}
]
}
}
},
"Methods": {
"provide": {
"RouterName": "dht-wan"
},
"find-providers": {
"RouterName": "parallel-dht-strict"
},
"find-peers": {
"RouterName": "parallel-dht-strict"
},
"get-ipns": {
"RouterName": "parallel-dht"
},
"put-ipns": {
"RouterName": "parallel-dht"
}
}
}YAML representation for clarity:
---
Type: custom
Routers:
dht-lan:
Type: dht
Parameters:
Mode: server
PublicIPNetwork: false
dht-wan:
Type: dht
Parameters:
Mode: auto
PublicIPNetwork: true
parallel-dht-strict:
Type: parallel
Parameters:
Routers:
- RouterName: dht-lan
- RouterName: dht-wan
parallel-dht:
Type: parallel
Parameters:
Routers:
- RouterName: dht-lan
IgnoreError: true
- RouterName: dht-wan
Methods:
provide:
RouterName: dht-wan
find-providers:
RouterName: parallel-dht-strict
find-peers:
RouterName: parallel-dht-strict
get-ipns:
RouterName: parallel-dht
put-ipns:
RouterName: parallel-dht
We need to create a config migration using fs-repo-migrations. We should remove the Routing.Type param and add the configuration specified previously.
We don't need to create any config migration! To avoid to the users the hassle of understanding how the new routing system works, we are gonna keep the old behavior. We will add the Type custom to make available the new Routing system.
No new security implications or considerations were found.
I got ideas from all of the following links to create this design document:
- ipfs#9079 (comment)
- ipfs#9157
- ipfs#9079 (comment)
- https://www.notion.so/pl-strflt/Delegated-Routing-Thoughts-very-very-WIP-0543bc51b1bd4d63a061b0f28e195d38
- https://gist.github.com/guseggert/effa027ff4cbadd7f67598efb6704d12
Copyright and related rights waived via CC0.