@helia/http 2.1.2 → 2.2.0

package/dist/src/index.d.ts

@@ -43,22 +43,22 @@
  * fs.cat(CID.parse('bafyFoo'))
  * ```
  */
+import type { DefaultLibp2pHTTPServices } from './utils/libp2p-defaults.ts';
+import type { Libp2pHTTPDefaultOptions } from './utils/libp2p.js';
 import type { Helia } from '@helia/interface';
 import type { HeliaInit } from '@helia/utils';
+import type { Libp2p } from '@libp2p/interface';
 export * from '@helia/interface';
-export interface HeliaHTTPInit extends HeliaInit {
-    /**
-     * Whether to start the Helia node
-     */
-    start?: boolean;
-}
+export type HeliaHTTPInit = HeliaInit<Libp2p<DefaultLibp2pHTTPServices>>;
+export type { DefaultLibp2pHTTPServices, Libp2pHTTPDefaultOptions };
 /**
- * Create and return the default options used to create a Helia node that only
- * uses HTTP services
+ * Create and return the default options used to create a Helia node
  */
-export declare function heliaDefaults(init?: Partial<HeliaHTTPInit>): Promise<HeliaHTTPInit>;
+export declare function heliaDefaults<T extends Libp2p>(init?: Partial<HeliaInit<T>>): Promise<Omit<HeliaInit<T>, 'libp2p'> & {
+    libp2p: T;
+}>;
 /**
  * Create and return a Helia node
  */
-export declare function createHeliaHTTP(init?: Partial<HeliaHTTPInit>): Promise<Helia>;
+export declare function createHeliaHTTP(init?: Partial<HeliaHTTPInit>): Promise<Helia<Libp2p<DefaultLibp2pHTTPServices>>>;
 //# 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAOH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAI7C,cAAc,kBAAkB,CAAA;AAEhC,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAE,IAAI,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAgB9F;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAE,IAAI,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAsBxF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AASH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAC3E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAI/C,cAAc,kBAAkB,CAAA;AAEhC,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAA;AAExE,YAAY,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,CAAA;AAEnE;;GAEG;AACH,wBAAsB,aAAa,CAAE,CAAC,SAAS,MAAM,EAAG,IAAI,GAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC,CAqC/I;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAE,IAAI,GAAE,OAAO,CAAC,aAAa,CAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAS3H"}

package/dist/src/index.js

@@ -44,52 +44,60 @@
  * ```
  */
 import { trustlessGateway } from '@helia/block-brokers';
-import { delegatedHTTPRouting, httpGatewayRouting } from '@helia/routers';
+import { httpGatewayRouting, libp2pRouting } from '@helia/routers';
 import { Helia as HeliaClass } from '@helia/utils';
 import { MemoryBlockstore } from 'blockstore-core';
 import { MemoryDatastore } from 'datastore-core';
+import { isLibp2p } from 'libp2p';
+import { createLibp2p } from "./utils/libp2p.js";
 // re-export interface types so people don't have to depend on @helia/interface
 // if they don't want to
 export * from '@helia/interface';
 /**
- * Create and return the default options used to create a Helia node that only
- * uses HTTP services
+ * Create and return the default options used to create a Helia node
  */
 export async function heliaDefaults(init = {}) {
     const datastore = init.datastore ?? new MemoryDatastore();
     const blockstore = init.blockstore ?? new MemoryBlockstore();
+    let libp2p;
+    if (isLibp2p(init.libp2p)) {
+        libp2p = init.libp2p;
+    }
+    else {
+        libp2p = await createLibp2p({
+            ...init,
+            libp2p: {
+                dns: init.dns,
+                ...init.libp2p,
+                // ignore the libp2p start parameter as it should be on the main init
+                // object instead
+                start: undefined
+            },
+            datastore
+        });
+    }
     return {
         ...init,
+        libp2p,
         datastore,
         blockstore,
         blockBrokers: init.blockBrokers ?? [
             trustlessGateway()
         ],
         routers: init.routers ?? [
-            delegatedHTTPRouting('https://delegated-ipfs.dev'),
+            libp2pRouting(libp2p),
             httpGatewayRouting()
-        ]
+        ],
+        metrics: libp2p.metrics
     };
 }
 /**
  * Create and return a Helia node
  */
 export async function createHeliaHTTP(init = {}) {
-    const datastore = init.datastore ?? new MemoryDatastore();
-    const blockstore = init.blockstore ?? new MemoryBlockstore();
-    const helia = new HeliaClass({
-        ...init,
-        datastore,
-        blockstore,
-        blockBrokers: init.blockBrokers ?? [
-            trustlessGateway()
-        ],
-        routers: init.routers ?? [
-            delegatedHTTPRouting('https://delegated-ipfs.dev'),
-            httpGatewayRouting()
-        ]
-    });
-    if (init.start !== false) {
+    const options = await heliaDefaults(init);
+    const helia = new HeliaClass(options);
+    if (options.start !== false) {
         await helia.start();
     }
     return helia;

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACzE,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAIhD,+EAA+E;AAC/E,wBAAwB;AACxB,cAAc,kBAAkB,CAAA;AAShC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAE,OAA+B,EAAE;IACpE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,eAAe,EAAE,CAAA;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,gBAAgB,EAAE,CAAA;IAE5D,OAAO;QACL,GAAG,IAAI;QACP,SAAS;QACT,UAAU;QACV,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI;YACjC,gBAAgB,EAAE;SACnB;QACD,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI;YACvB,oBAAoB,CAAC,4BAA4B,CAAC;YAClD,kBAAkB,EAAE;SACrB;KACF,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAE,OAA+B,EAAE;IACtE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,eAAe,EAAE,CAAA;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,gBAAgB,EAAE,CAAA;IAE5D,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC;QAC3B,GAAG,IAAI;QACP,SAAS;QACT,UAAU;QACV,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI;YACjC,gBAAgB,EAAE;SACnB;QACD,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI;YACvB,oBAAoB,CAAC,4BAA4B,CAAC;YAClD,kBAAkB,EAAE;SACrB;KACF,CAAC,CAAA;IAEF,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAOhD,+EAA+E;AAC/E,wBAAwB;AACxB,cAAc,kBAAkB,CAAA;AAMhC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAqB,OAA8B,EAAE;IACtF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,eAAe,EAAE,CAAA;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,gBAAgB,EAAE,CAAA;IAE5D,IAAI,MAAW,CAAA;IAEf,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,MAAM,YAAY,CAA4B;YACrD,GAAG,IAAI;YACP,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,GAAG,IAAI,CAAC,MAAM;gBAEd,qEAAqE;gBACrE,iBAAiB;gBACjB,KAAK,EAAE,SAAS;aACjB;YACD,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,MAAM;QACN,SAAS;QACT,UAAU;QACV,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI;YACjC,gBAAgB,EAAE;SACnB;QACD,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI;YACvB,aAAa,CAAC,MAAM,CAAC;YACrB,kBAAkB,EAAE;SACrB;QACD,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAE,OAA+B,EAAE;IACtE,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,CAAA;IACzC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;IAErC,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;QAC5B,MAAM,KAAK,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/src/utils/libp2p-defaults.d.ts

@@ -0,0 +1,9 @@
+import type { Libp2pHTTPDefaultOptions } from './libp2p.js';
+import type { Keychain } from '@libp2p/keychain';
+import type { Libp2pOptions } from 'libp2p';
+export interface DefaultLibp2pHTTPServices extends Record<string, unknown> {
+    delegatedRouting: unknown;
+    keychain: Keychain;
+}
+export declare function libp2pDefaults(options?: Libp2pHTTPDefaultOptions): Libp2pOptions<DefaultLibp2pHTTPServices> & Required<Pick<Libp2pOptions<DefaultLibp2pHTTPServices>, 'services'>>;
+//# sourceMappingURL=libp2p-defaults.d.ts.map

package/dist/src/utils/libp2p-defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"libp2p-defaults.d.ts","sourceRoot":"","sources":["../../../src/utils/libp2p-defaults.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AAE3C,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxE,gBAAgB,EAAE,OAAO,CAAA;IACzB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,wBAAgB,cAAc,CAAE,OAAO,GAAE,wBAA6B,GAAG,aAAa,CAAC,yBAAyB,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE,UAAU,CAAC,CAAC,CAyBvL"}

package/dist/src/utils/libp2p-defaults.js

@@ -0,0 +1,28 @@
+import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client';
+import { keychain } from '@libp2p/keychain';
+import { userAgent } from 'libp2p/user-agent';
+export function libp2pDefaults(options = {}) {
+    const agentVersion = `@helia/http ${userAgent()}`;
+    return {
+        privateKey: options.privateKey,
+        dns: options.dns,
+        nodeInfo: {
+            userAgent: agentVersion
+        },
+        addresses: {
+            listen: []
+        },
+        transports: [],
+        connectionEncrypters: [],
+        streamMuxers: [],
+        peerDiscovery: [],
+        services: {
+            delegatedRouting: () => createDelegatedRoutingV1HttpApiClient('https://delegated-ipfs.dev', {
+                filterAddrs: ['https'],
+                filterProtocols: ['transport-ipfs-gateway-http']
+            }),
+            keychain: keychain(options.keychain)
+        }
+    };
+}
+//# sourceMappingURL=libp2p-defaults.js.map

package/dist/src/utils/libp2p-defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libp2p-defaults.js","sourceRoot":"","sources":["../../../src/utils/libp2p-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qCAAqC,EAAE,MAAM,6CAA6C,CAAA;AACnG,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAU7C,MAAM,UAAU,cAAc,CAAE,UAAoC,EAAE;IACpE,MAAM,YAAY,GAAG,eAAe,SAAS,EAAE,EAAE,CAAA;IAEjD,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,QAAQ,EAAE;YACR,SAAS,EAAE,YAAY;SACxB;QACD,SAAS,EAAE;YACT,MAAM,EAAE,EAAE;SACX;QACD,UAAU,EAAE,EAAE;QACd,oBAAoB,EAAE,EAAE;QACxB,YAAY,EAAE,EAAE;QAChB,aAAa,EAAE,EAAE;QACjB,QAAQ,EAAE;YACR,gBAAgB,EAAE,GAAG,EAAE,CACrB,qCAAqC,CAAC,4BAA4B,EAAE;gBAClE,WAAW,EAAE,CAAC,OAAO,CAAC;gBACtB,eAAe,EAAE,CAAC,6BAA6B,CAAC;aACjD,CAAC;YACJ,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC;SACrC;KACF,CAAA;AACH,CAAC"}

package/dist/src/utils/libp2p.d.ts

@@ -0,0 +1,19 @@
+import type { ComponentLogger, Libp2p, PrivateKey } from '@libp2p/interface';
+import type { KeychainInit } from '@libp2p/keychain';
+import type { DNS } from '@multiformats/dns';
+import type { Datastore } from 'interface-datastore';
+import type { Libp2pOptions } from 'libp2p';
+export interface CreateLibp2pHTTPOptions<T extends Record<string, unknown>> {
+    datastore: Datastore;
+    libp2p?: Libp2pOptions<T>;
+    logger?: ComponentLogger;
+    keychain?: KeychainInit;
+    start?: boolean;
+}
+export interface Libp2pHTTPDefaultOptions {
+    privateKey?: PrivateKey;
+    keychain?: KeychainInit;
+    dns?: DNS;
+}
+export declare function createLibp2p<T extends Record<string, unknown>>(options: CreateLibp2pHTTPOptions<T>): Promise<Libp2p<T>>;
+//# sourceMappingURL=libp2p.d.ts.map

package/dist/src/utils/libp2p.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"libp2p.d.ts","sourceRoot":"","sources":["../../../src/utils/libp2p.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AAE3C,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxE,SAAS,EAAE,SAAS,CAAA;IACpB,MAAM,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,wBAAsB,YAAY,CAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAG,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAkB/H"}

package/dist/src/utils/libp2p.js

@@ -0,0 +1,19 @@
+import { loadOrCreateSelfKey } from '@libp2p/config';
+import { createLibp2p as create } from 'libp2p';
+import { libp2pDefaults } from './libp2p-defaults.js';
+export async function createLibp2p(options) {
+    const libp2pOptions = options.libp2p ?? {};
+    // if no peer id was passed, try to load it from the keychain
+    if (libp2pOptions.privateKey == null && options.datastore != null) {
+        libp2pOptions.privateKey = await loadOrCreateSelfKey(options.datastore, options.keychain);
+    }
+    const defaults = libp2pDefaults(libp2pOptions);
+    defaults.datastore = defaults.datastore ?? options.datastore;
+    const node = await create({
+        ...defaults,
+        ...libp2pOptions,
+        start: false
+    });
+    return node;
+}
+//# sourceMappingURL=libp2p.js.map

package/dist/src/utils/libp2p.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libp2p.js","sourceRoot":"","sources":["../../../src/utils/libp2p.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,YAAY,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAqBrD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAsC,OAAmC;IACzG,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAA;IAE1C,6DAA6D;IAC7D,IAAI,aAAa,CAAC,UAAU,IAAI,IAAI,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAClE,aAAa,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC3F,CAAC;IAED,MAAM,QAAQ,GAAQ,cAAc,CAAC,aAAa,CAAC,CAAA;IACnD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAA;IAE5D,MAAM,IAAI,GAAG,MAAM,MAAM,CAAI;QAC3B,GAAG,QAAQ;QACX,GAAG,aAAa;QAChB,KAAK,EAAE,KAAK;KACb,CAAC,CAAA;IAEF,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/typedoc-urls.json

@@ -1,6 +1,8 @@
 {
-  "HeliaHTTPInit": "https://ipfs.github.io/helia/interfaces/_helia_http.HeliaHTTPInit.html",
-  ".:HeliaHTTPInit": "https://ipfs.github.io/helia/interfaces/_helia_http.HeliaHTTPInit.html",
+  "DefaultLibp2pHTTPServices": "https://ipfs.github.io/helia/interfaces/_helia_http.DefaultLibp2pHTTPServices.html",
+  "Libp2pHTTPDefaultOptions": "https://ipfs.github.io/helia/interfaces/_helia_http.Libp2pHTTPDefaultOptions.html",
+  "HeliaHTTPInit": "https://ipfs.github.io/helia/types/_helia_http.HeliaHTTPInit.html",
+  ".:HeliaHTTPInit": "https://ipfs.github.io/helia/types/_helia_http.HeliaHTTPInit.html",
   "createHeliaHTTP": "https://ipfs.github.io/helia/functions/_helia_http.createHeliaHTTP.html",
   ".:createHeliaHTTP": "https://ipfs.github.io/helia/functions/_helia_http.createHeliaHTTP.html",
   "heliaDefaults": "https://ipfs.github.io/helia/functions/_helia_http.heliaDefaults.html",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/http",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "A lightweight implementation of IPFS over HTTP in JavaScript",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/http#readme",
@@ -54,17 +54,22 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@helia/block-brokers": "^4.2.2",
-    "@helia/interface": "^5.3.2",
-    "@helia/routers": "^3.1.2",
-    "@helia/utils": "^1.3.2",
+    "@helia/block-brokers": "^4.2.3",
+    "@helia/delegated-routing-v1-http-api-client": "^4.2.5",
+    "@helia/interface": "^5.4.0",
+    "@helia/routers": "^3.1.3",
+    "@helia/utils": "^1.4.0",
+    "@libp2p/config": "^1.1.13",
+    "@libp2p/interface": "^2.10.5",
+    "@libp2p/keychain": "^5.2.8",
+    "@multiformats/dns": "^1.0.6",
     "blockstore-core": "^5.0.2",
-    "datastore-core": "^10.0.2"
+    "datastore-core": "^10.0.2",
+    "interface-datastore": "^8.3.2",
+    "libp2p": "^2.9.0"
   },
   "devDependencies": {
-    "@libp2p/interface": "^2.2.1",
     "aegir": "^47.0.7",
-    "interface-datastore": "^8.3.1",
     "multiformats": "^13.3.1",
     "sinon": "^20.0.0",
     "sinon-ts": "^2.0.0"

package/src/index.ts

@@ -45,67 +45,76 @@
  */
 
 import { trustlessGateway } from '@helia/block-brokers'
-import { delegatedHTTPRouting, httpGatewayRouting } from '@helia/routers'
+import { httpGatewayRouting, libp2pRouting } from '@helia/routers'
 import { Helia as HeliaClass } from '@helia/utils'
 import { MemoryBlockstore } from 'blockstore-core'
 import { MemoryDatastore } from 'datastore-core'
+import { isLibp2p } from 'libp2p'
+import { createLibp2p } from './utils/libp2p.ts'
+import type { DefaultLibp2pHTTPServices } from './utils/libp2p-defaults.ts'
+import type { Libp2pHTTPDefaultOptions } from './utils/libp2p.js'
 import type { Helia } from '@helia/interface'
 import type { HeliaInit } from '@helia/utils'
+import type { Libp2p } from '@libp2p/interface'
 
 // re-export interface types so people don't have to depend on @helia/interface
 // if they don't want to
 export * from '@helia/interface'
 
-export interface HeliaHTTPInit extends HeliaInit {
-  /**
-   * Whether to start the Helia node
-   */
-  start?: boolean
-}
+export type HeliaHTTPInit = HeliaInit<Libp2p<DefaultLibp2pHTTPServices>>
+
+export type { DefaultLibp2pHTTPServices, Libp2pHTTPDefaultOptions }
 
 /**
- * Create and return the default options used to create a Helia node that only
- * uses HTTP services
+ * Create and return the default options used to create a Helia node
  */
-export async function heliaDefaults (init: Partial<HeliaHTTPInit> = {}): Promise<HeliaHTTPInit> {
+export async function heliaDefaults <T extends Libp2p> (init: Partial<HeliaInit<T>> = {}): Promise<Omit<HeliaInit<T>, 'libp2p'> & { libp2p: T }> {
   const datastore = init.datastore ?? new MemoryDatastore()
   const blockstore = init.blockstore ?? new MemoryBlockstore()
 
+  let libp2p: any
+
+  if (isLibp2p(init.libp2p)) {
+    libp2p = init.libp2p
+  } else {
+    libp2p = await createLibp2p<DefaultLibp2pHTTPServices>({
+      ...init,
+      libp2p: {
+        dns: init.dns,
+        ...init.libp2p,
+
+        // ignore the libp2p start parameter as it should be on the main init
+        // object instead
+        start: undefined
+      },
+      datastore
+    })
+  }
+
   return {
     ...init,
+    libp2p,
     datastore,
     blockstore,
     blockBrokers: init.blockBrokers ?? [
       trustlessGateway()
     ],
     routers: init.routers ?? [
-      delegatedHTTPRouting('https://delegated-ipfs.dev'),
+      libp2pRouting(libp2p),
       httpGatewayRouting()
-    ]
+    ],
+    metrics: libp2p.metrics
   }
 }
 
 /**
  * Create and return a Helia node
  */
-export async function createHeliaHTTP (init: Partial<HeliaHTTPInit> = {}): Promise<Helia> {
-  const datastore = init.datastore ?? new MemoryDatastore()
-  const blockstore = init.blockstore ?? new MemoryBlockstore()
-
-  const helia = new HeliaClass({
-    ...init,
-    datastore,
-    blockstore,
-    blockBrokers: init.blockBrokers ?? [
-      trustlessGateway()
-    ],
-    routers: init.routers ?? [
-      delegatedHTTPRouting('https://delegated-ipfs.dev'),
-      httpGatewayRouting()
-    ]
-  })
+export async function createHeliaHTTP (init: Partial<HeliaHTTPInit> = {}): Promise<Helia<Libp2p<DefaultLibp2pHTTPServices>>> {
+  const options = await heliaDefaults(init)
+  const helia = new HeliaClass(options)
 
-  if (init.start !== false) {
+  if (options.start !== false) {
     await helia.start()
   }
 

package/src/utils/libp2p-defaults.ts

@@ -0,0 +1,38 @@
+import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
+import { keychain } from '@libp2p/keychain'
+import { userAgent } from 'libp2p/user-agent'
+import type { Libp2pHTTPDefaultOptions } from './libp2p.js'
+import type { Keychain } from '@libp2p/keychain'
+import type { Libp2pOptions } from 'libp2p'
+
+export interface DefaultLibp2pHTTPServices extends Record<string, unknown> {
+  delegatedRouting: unknown
+  keychain: Keychain
+}
+
+export function libp2pDefaults (options: Libp2pHTTPDefaultOptions = {}): Libp2pOptions<DefaultLibp2pHTTPServices> & Required<Pick<Libp2pOptions<DefaultLibp2pHTTPServices>, 'services'>> {
+  const agentVersion = `@helia/http ${userAgent()}`
+
+  return {
+    privateKey: options.privateKey,
+    dns: options.dns,
+    nodeInfo: {
+      userAgent: agentVersion
+    },
+    addresses: {
+      listen: []
+    },
+    transports: [],
+    connectionEncrypters: [],
+    streamMuxers: [],
+    peerDiscovery: [],
+    services: {
+      delegatedRouting: () =>
+        createDelegatedRoutingV1HttpApiClient('https://delegated-ipfs.dev', {
+          filterAddrs: ['https'],
+          filterProtocols: ['transport-ipfs-gateway-http']
+        }),
+      keychain: keychain(options.keychain)
+    }
+  }
+}

package/src/utils/libp2p.ts

@@ -0,0 +1,42 @@
+import { loadOrCreateSelfKey } from '@libp2p/config'
+import { createLibp2p as create } from 'libp2p'
+import { libp2pDefaults } from './libp2p-defaults.js'
+import type { ComponentLogger, Libp2p, PrivateKey } from '@libp2p/interface'
+import type { KeychainInit } from '@libp2p/keychain'
+import type { DNS } from '@multiformats/dns'
+import type { Datastore } from 'interface-datastore'
+import type { Libp2pOptions } from 'libp2p'
+
+export interface CreateLibp2pHTTPOptions<T extends Record<string, unknown>> {
+  datastore: Datastore
+  libp2p?: Libp2pOptions<T>
+  logger?: ComponentLogger
+  keychain?: KeychainInit
+  start?: boolean
+}
+
+export interface Libp2pHTTPDefaultOptions {
+  privateKey?: PrivateKey
+  keychain?: KeychainInit
+  dns?: DNS
+}
+
+export async function createLibp2p <T extends Record<string, unknown>> (options: CreateLibp2pHTTPOptions<T>): Promise<Libp2p<T>> {
+  const libp2pOptions = options.libp2p ?? {}
+
+  // if no peer id was passed, try to load it from the keychain
+  if (libp2pOptions.privateKey == null && options.datastore != null) {
+    libp2pOptions.privateKey = await loadOrCreateSelfKey(options.datastore, options.keychain)
+  }
+
+  const defaults: any = libp2pDefaults(libp2pOptions)
+  defaults.datastore = defaults.datastore ?? options.datastore
+
+  const node = await create<T>({
+    ...defaults,
+    ...libp2pOptions,
+    start: false
+  })
+
+  return node
+}