feat: enable customising delegated http router (#654)

Allow passing delegated routing client options, e.g. IPIP-484 filters, to the delegated HTTP router. --------- Co-authored-by: Daniel N <[email protected]> Co-authored-by: Alex Potsides <[email protected]>
ipfs · Oct 23, 2024 · 693c82d · 693c82d
1 parent 8364296
commit 693c82d
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 6 deletions.
diff --git a/packages/routers/package.json b/packages/routers/package.json
@@ -54,7 +54,7 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@helia/delegated-routing-v1-http-api-client": "^4.0.0",
+    "@helia/delegated-routing-v1-http-api-client": "^4.1.0",
     "@helia/interface": "^5.0.0",
     "@libp2p/peer-id": "^5.0.0",
     "@libp2p/interface": "^2.0.0",
@@ -72,5 +72,8 @@
     "it-drain": "^3.0.5",
     "sinon-ts": "^2.0.0"
   },
+  "browser": {
+    "./dist/src/utils/delegated-http-routing-defaults.js": "./dist/src/utils/delegated-http-routing-defaults.browser.js"
+  },
   "sideEffects": false
 }
diff --git a/packages/routers/src/delegated-http-routing.ts b/packages/routers/src/delegated-http-routing.ts
@@ -6,7 +6,8 @@ import map from 'it-map'
 import { CID } from 'multiformats/cid'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import type { DelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
+import { delegatedHTTPRoutingDefaults } from './utils/delegated-http-routing-defaults.js'
+import type { DelegatedRoutingV1HttpApiClient, DelegatedRoutingV1HttpApiClientInit } from '@helia/delegated-routing-v1-http-api-client'
 import type { Provider, Routing, RoutingOptions } from '@helia/interface'
 import type { PeerId, PeerInfo } from '@libp2p/interface'
 import type { Version } from 'multiformats'
@@ -20,8 +21,8 @@ function isIPNSKey (key: Uint8Array): boolean {
 class DelegatedHTTPRouter implements Routing {
   private readonly client: DelegatedRoutingV1HttpApiClient
 
-  constructor (url: URL) {
-    this.client = createDelegatedRoutingV1HttpApiClient(url)
+  constructor (url: URL, init: DelegatedRoutingV1HttpApiClientInit = {}) {
+    this.client = createDelegatedRoutingV1HttpApiClient(url, init)
   }
 
   async provide (cid: CID, options?: RoutingOptions | undefined): Promise<void> {
@@ -94,6 +95,7 @@ class DelegatedHTTPRouter implements Routing {
 /**
  * Creates a Helia Router that connects to an endpoint that supports the [Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) spec.
  */
-export function delegatedHTTPRouting (url: string | URL): Routing {
-  return new DelegatedHTTPRouter(new URL(url))
+export function delegatedHTTPRouting (url: string | URL, init?: DelegatedRoutingV1HttpApiClientInit): Routing {
+  const config = init ?? delegatedHTTPRoutingDefaults()
+  return new DelegatedHTTPRouter(new URL(url), config)
 }
diff --git a/packages/routers/src/utils/delegated-http-routing-defaults.browser.ts b/packages/routers/src/utils/delegated-http-routing-defaults.browser.ts
@@ -0,0 +1,8 @@
+import type { DelegatedRoutingV1HttpApiClientInit } from '@helia/delegated-routing-v1-http-api-client'
+
+export function delegatedHTTPRoutingDefaults (): DelegatedRoutingV1HttpApiClientInit {
+  return {
+    filterProtocols: ['unknown', 'transport-bitswap', 'transport-ipfs-gateway-http'],
+    filterAddrs: ['https', 'webtransport', 'webrtc', 'webrtc-direct', 'wss']
+  }
+}
diff --git a/packages/routers/src/utils/delegated-http-routing-defaults.ts b/packages/routers/src/utils/delegated-http-routing-defaults.ts
@@ -0,0 +1,8 @@
+import type { DelegatedRoutingV1HttpApiClientInit } from '@helia/delegated-routing-v1-http-api-client'
+
+export function delegatedHTTPRoutingDefaults (): DelegatedRoutingV1HttpApiClientInit {
+  return {
+    filterProtocols: ['unknown', 'transport-bitswap', 'transport-ipfs-gateway-http'],
+    filterAddrs: ['https', 'tcp', 'webrtc', 'webrtc-direct', 'wss']
+  }
+}