@helia/routers 1.0.3 → 1.1.0

package/dist/src/http-gateway-routing.d.ts

@@ -0,0 +1,10 @@
+import type { Routing } from '@helia/interface';
+export declare const DEFAULT_TRUSTLESS_GATEWAYS: string[];
+export interface HTTPGatwayRouterInit {
+    gateways?: Array<URL | string>;
+}
+/**
+ * Returns a static list of HTTP Gateways as providers
+ */
+export declare function httpGatewayRouting(init?: HTTPGatwayRouterInit): Partial<Routing>;
+//# sourceMappingURL=http-gateway-routing.d.ts.map

package/dist/src/http-gateway-routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-gateway-routing.d.ts","sourceRoot":"","sources":["../../src/http-gateway-routing.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAY,OAAO,EAAkB,MAAM,kBAAkB,CAAA;AAIzE,eAAO,MAAM,0BAA0B,UAMtC,CAAA;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,CAAA;CAC/B;AA2ED;;GAEG;AACH,wBAAgB,kBAAkB,CAAE,IAAI,GAAE,oBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAErF"}

package/dist/src/http-gateway-routing.js

@@ -0,0 +1,76 @@
+import { peerIdSymbol } from '@libp2p/interface';
+import { uriToMultiaddr } from '@multiformats/uri-to-multiaddr';
+import { CID } from 'multiformats/cid';
+import { identity } from 'multiformats/hashes/identity';
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+export const DEFAULT_TRUSTLESS_GATEWAYS = [
+    // 2023-10-03: IPNS, Origin, and Block/CAR support from https://ipfs-public-gateway-checker.on.fleek.co/
+    'https://trustless-gateway.link',
+    // 2023-10-03: IPNS, Origin, and Block/CAR support from https://ipfs-public-gateway-checker.on.fleek.co/
+    'https://4everland.io'
+];
+// these values are from https://github.com/multiformats/multicodec/blob/master/table.csv
+const TRANSPORT_IPFS_GATEWAY_HTTP_CODE = 0x0920;
+const inspect = Symbol.for('nodejs.util.inspect.custom');
+class URLPeerId {
+    type = 'url';
+    multihash;
+    privateKey;
+    publicKey;
+    url;
+    constructor(url) {
+        this.url = url.toString();
+        this.multihash = identity.digest(uint8ArrayFromString(this.url));
+    }
+    [inspect]() {
+        return `PeerId(${this.url})`;
+    }
+    [peerIdSymbol] = true;
+    toString() {
+        return this.toCID().toString();
+    }
+    toCID() {
+        return CID.createV1(TRANSPORT_IPFS_GATEWAY_HTTP_CODE, this.multihash);
+    }
+    toBytes() {
+        return this.toCID().bytes;
+    }
+    equals(other) {
+        if (other == null) {
+            return false;
+        }
+        if (other instanceof Uint8Array) {
+            other = uint8ArrayToString(other);
+        }
+        return other.toString() === this.toString();
+    }
+}
+function toPeerInfo(url) {
+    url = url.toString();
+    return {
+        id: new URLPeerId(new URL(url)),
+        multiaddrs: [
+            uriToMultiaddr(url)
+        ]
+    };
+}
+class HTTPGatwayRouter {
+    gateways;
+    constructor(init = {}) {
+        this.gateways = (init.gateways ?? DEFAULT_TRUSTLESS_GATEWAYS).map(url => toPeerInfo(url));
+    }
+    async *findProviders(cid, options) {
+        yield* this.gateways.toSorted(() => Math.random() > 0.5 ? 1 : -1).map(info => ({
+            ...info,
+            protocols: ['transport-ipfs-gateway-http']
+        }));
+    }
+}
+/**
+ * Returns a static list of HTTP Gateways as providers
+ */
+export function httpGatewayRouting(init = {}) {
+    return new HTTPGatwayRouter(init);
+}
+//# sourceMappingURL=http-gateway-routing.js.map

package/dist/src/http-gateway-routing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-gateway-routing.js","sourceRoot":"","sources":["../../src/http-gateway-routing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAC/D,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AACvD,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAKtE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,wGAAwG;IACxG,gCAAgC;IAEhC,wGAAwG;IACxG,sBAAsB;CACvB,CAAA;AAMD,yFAAyF;AACzF,MAAM,gCAAgC,GAAG,MAAM,CAAA;AAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;AAExD,MAAM,SAAS;IACJ,IAAI,GAAG,KAAK,CAAA;IACZ,SAAS,CAAiB;IAC1B,UAAU,CAAa;IACvB,SAAS,CAAa;IACtB,GAAG,CAAQ;IAEpB,YAAa,GAAQ;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;QACzB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAClE,CAAC;IAED,CAAC,OAAO,CAAC;QACP,OAAO,UAAU,IAAI,CAAC,GAAG,GAAG,CAAA;IAC9B,CAAC;IAEQ,CAAC,YAAY,CAAC,GAAG,IAAI,CAAA;IAE9B,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAA;IAChC,CAAC;IAED,KAAK;QACH,OAAO,GAAG,CAAC,QAAQ,CAAC,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACvE,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAA;IAC3B,CAAC;IAED,MAAM,CAAE,KAAoC;QAC1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;QAED,OAAO,KAAK,CAAC,QAAQ,EAAE,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAA;IAC7C,CAAC;CACF;AAED,SAAS,UAAU,CAAE,GAAiB;IACpC,GAAG,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IAEpB,OAAO;QACL,EAAE,EAAE,IAAI,SAAS,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,UAAU,EAAE;YACV,cAAc,CAAC,GAAG,CAAC;SACpB;KACF,CAAA;AACH,CAAC;AAED,MAAM,gBAAgB;IACH,QAAQ,CAAY;IAErC,YAAa,OAA6B,EAAE;QAC1C,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,0BAA0B,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;IAC3F,CAAC;IAED,KAAK,CAAC,CAAE,aAAa,CAAE,GAA0C,EAAE,OAAoC;QACrG,KAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9E,GAAG,IAAI;YACP,SAAS,EAAE,CAAC,6BAA6B,CAAC;SAC3C,CAAC,CAAC,CAAA;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAE,OAA6B,EAAE;IACjE,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAA;AACnC,CAAC"}

package/dist/src/index.d.ts

@@ -4,5 +4,6 @@
  * Abstraction layer over different content and peer routing mechanisms.
  */
 export { delegatedHTTPRouting } from './delegated-http-routing.js';
+export { httpGatewayRouting } from './http-gateway-routing.js';
 export { libp2pRouting } from './libp2p-routing.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA"}

package/dist/src/index.js

@@ -4,5 +4,6 @@
  * Abstraction layer over different content and peer routing mechanisms.
  */
 export { delegatedHTTPRouting } from './delegated-http-routing.js';
+export { httpGatewayRouting } from './http-gateway-routing.js';
 export { libp2pRouting } from './libp2p-routing.js';
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA"}

package/dist/typedoc-urls.json

@@ -1,4 +1,5 @@
 {
   "delegatedHTTPRouting": "https://ipfs.github.io/helia/functions/_helia_routers.delegatedHTTPRouting.html",
+  "httpGatewayRouting": "https://ipfs.github.io/helia/functions/_helia_routers.httpGatewayRouting.html",
   "libp2pRouting": "https://ipfs.github.io/helia/functions/_helia_routers.libp2pRouting.html"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/routers",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Routers for Helia",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/routers#readme",
@@ -54,8 +54,9 @@
   },
   "dependencies": {
     "@helia/delegated-routing-v1-http-api-client": "^3.0.0",
-    "@helia/interface": "^4.2.0",
+    "@helia/interface": "^4.3.0",
     "@libp2p/interface": "^1.1.4",
+    "@multiformats/uri-to-multiaddr": "^8.0.0",
     "ipns": "^9.0.0",
     "it-first": "^3.0.4",
     "it-map": "^3.0.5",
@@ -66,6 +67,7 @@
     "@libp2p/peer-id": "^4.0.7",
     "@libp2p/peer-id-factory": "^4.0.7",
     "aegir": "^42.2.5",
+    "it-all": "^3.0.4",
     "it-drain": "^3.0.5",
     "sinon-ts": "^2.0.0"
   },

package/src/http-gateway-routing.ts

@@ -0,0 +1,101 @@
+import { peerIdSymbol } from '@libp2p/interface'
+import { uriToMultiaddr } from '@multiformats/uri-to-multiaddr'
+import { CID } from 'multiformats/cid'
+import { identity } from 'multiformats/hashes/identity'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import type { Provider, Routing, RoutingOptions } from '@helia/interface'
+import type { PeerId, PeerInfo } from '@libp2p/interface'
+import type { MultihashDigest, Version } from 'multiformats'
+
+export const DEFAULT_TRUSTLESS_GATEWAYS = [
+  // 2023-10-03: IPNS, Origin, and Block/CAR support from https://ipfs-public-gateway-checker.on.fleek.co/
+  'https://trustless-gateway.link',
+
+  // 2023-10-03: IPNS, Origin, and Block/CAR support from https://ipfs-public-gateway-checker.on.fleek.co/
+  'https://4everland.io'
+]
+
+export interface HTTPGatwayRouterInit {
+  gateways?: Array<URL | string>
+}
+
+// these values are from https://github.com/multiformats/multicodec/blob/master/table.csv
+const TRANSPORT_IPFS_GATEWAY_HTTP_CODE = 0x0920
+const inspect = Symbol.for('nodejs.util.inspect.custom')
+
+class URLPeerId implements PeerId {
+  readonly type = 'url'
+  readonly multihash: MultihashDigest
+  readonly privateKey?: Uint8Array
+  readonly publicKey?: Uint8Array
+  readonly url: string
+
+  constructor (url: URL) {
+    this.url = url.toString()
+    this.multihash = identity.digest(uint8ArrayFromString(this.url))
+  }
+
+  [inspect] (): string {
+    return `PeerId(${this.url})`
+  }
+
+  readonly [peerIdSymbol] = true
+
+  toString (): string {
+    return this.toCID().toString()
+  }
+
+  toCID (): CID {
+    return CID.createV1(TRANSPORT_IPFS_GATEWAY_HTTP_CODE, this.multihash)
+  }
+
+  toBytes (): Uint8Array {
+    return this.toCID().bytes
+  }
+
+  equals (other?: PeerId | Uint8Array | string): boolean {
+    if (other == null) {
+      return false
+    }
+
+    if (other instanceof Uint8Array) {
+      other = uint8ArrayToString(other)
+    }
+
+    return other.toString() === this.toString()
+  }
+}
+
+function toPeerInfo (url: string | URL): PeerInfo {
+  url = url.toString()
+
+  return {
+    id: new URLPeerId(new URL(url)),
+    multiaddrs: [
+      uriToMultiaddr(url)
+    ]
+  }
+}
+
+class HTTPGatwayRouter implements Partial<Routing> {
+  private readonly gateways: PeerInfo[]
+
+  constructor (init: HTTPGatwayRouterInit = {}) {
+    this.gateways = (init.gateways ?? DEFAULT_TRUSTLESS_GATEWAYS).map(url => toPeerInfo(url))
+  }
+
+  async * findProviders (cid: CID<unknown, number, number, Version>, options?: RoutingOptions | undefined): AsyncIterable<Provider> {
+    yield * this.gateways.toSorted(() => Math.random() > 0.5 ? 1 : -1).map(info => ({
+      ...info,
+      protocols: ['transport-ipfs-gateway-http']
+    }))
+  }
+}
+
+/**
+ * Returns a static list of HTTP Gateways as providers
+ */
+export function httpGatewayRouting (init: HTTPGatwayRouterInit = {}): Partial<Routing> {
+  return new HTTPGatwayRouter(init)
+}

package/src/index.ts

@@ -4,4 +4,5 @@
  * Abstraction layer over different content and peer routing mechanisms.
  */
 export { delegatedHTTPRouting } from './delegated-http-routing.js'
+export { httpGatewayRouting } from './http-gateway-routing.js'
 export { libp2pRouting } from './libp2p-routing.js'