@helia/interface 6.2.0 → 6.2.1-17530ed8

package/dist/src/routing.d.ts

@@ -1,4 +1,5 @@
-import type { AbortOptions, PeerId, PeerInfo, TraceOptions } from '@libp2p/interface';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { AbortOptions } from 'abort-error';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 /**
@@ -7,7 +8,7 @@ import type { ProgressEvent, ProgressOptions } from 'progress-events';
  * local cache that may be used in preference over network calls, for example
  * when a record has a TTL.
  */
-export interface RoutingOptions<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event>, TraceOptions {
+export interface RoutingOptions<Event extends ProgressEvent = any> extends AbortOptions, ProgressOptions<Event> {
     /**
      * Pass `false` to not use the network
      *
@@ -26,11 +27,36 @@ export interface RoutingOptions<Event extends ProgressEvent = any> extends Abort
      * @default true
      */
     validate?: boolean;
+    /**
+     * Where tracing is used, this value carries tracing context
+     */
+    trace?: any;
+}
+/**
+ * A Peer is another node on the network
+ */
+export interface Peer {
+    /**
+     * The identifier of the remote peer
+     */
+    id: CID;
+    /**
+     * The multiaddrs a peer is listening on
+     */
+    multiaddrs: Multiaddr[];
 }
 /**
  * A provider can supply the content for a CID
  */
-export interface Provider extends PeerInfo {
+export interface Provider {
+    /**
+     * The identifier of the remote peer, a CID
+     */
+    id: CID;
+    /**
+     * The multiaddrs a peer is listening on
+     */
+    multiaddrs: Multiaddr[];
     /**
      * If present these are the methods that the peer can supply the content via.
      *
@@ -61,14 +87,14 @@ export interface RoutingFindProvidersEndEvent {
 export interface RoutingFindProvidersHttpGatewayProvider {
     routing: 'http-gateway-router';
     cid: CID;
-    provider: PeerInfo & {
+    provider: Peer & {
         protocols: ['transport-ipfs-gateway-http'];
     };
 }
 export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
     routing: 'delegated-http-router';
     cid: CID;
-    provider: PeerInfo & {
+    provider: Peer & {
         routing: 'delegated-http-routing';
         protocols: string[];
     };
@@ -76,7 +102,7 @@ export interface RoutingFindProvidersDelegatedHttpRoutingProvider {
 export interface RoutingFindProvidersLibp2pProvider {
     routing: 'libp2p-router';
     cid: CID;
-    provider: PeerInfo;
+    provider: Peer;
 }
 export type RoutingFindProvidersProviderEvent = RoutingFindProvidersHttpGatewayProvider | RoutingFindProvidersDelegatedHttpRoutingProvider | RoutingFindProvidersLibp2pProvider;
 export type RoutingFindProvidersProgressEvents = ProgressEvent<'helia:routing:find-providers:start', RoutingFindProvidersStartEvent> | ProgressEvent<'helia:routing:find-providers:provider', RoutingFindProvidersProviderEvent> | ProgressEvent<'helia:routing:find-providers:end', RoutingFindProvidersEndEvent> | RoutingFindPeerProgressEvents;
@@ -120,11 +146,11 @@ export interface RoutingGetEndEvent {
 export type RoutingGetProgressEvents = ProgressEvent<'helia:routing:get:start', RoutingGetStartEvent> | ProgressEvent<'helia:routing:get:end', RoutingGetEndEvent>;
 export interface RoutingFindPeerStartEvent {
     routing: string;
-    peerId: PeerId;
+    peerId: CID;
 }
 export interface RoutingFindPeerEndEvent {
     routing: string;
-    peerId: PeerId;
+    peerId: CID;
 }
 export type RoutingFindPeerProgressEvents = ProgressEvent<'helia:routing:find-peer:start', RoutingFindPeerStartEvent> | ProgressEvent<'helia:routing:find-peer:end', RoutingFindPeerEndEvent>;
 export interface RoutingGetClosestPeersStartEvent {
@@ -136,7 +162,7 @@ export interface RoutingGetClosestPeersEndEvent {
     key: Uint8Array;
 }
 export type RoutingGetClosestPeersProgressEvents = ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> | ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>;
-export interface Routing {
+export interface Router {
     /**
      * The name of this routing implementation
      */
@@ -149,10 +175,12 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * await contentRouting.provide(cid)
+     * await contentRouting.provide(cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    provide(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): Promise<void>;
+    provide?(cid: CID, options?: RoutingOptions<RoutingProvideProgressEvents>): Promise<void>;
     /**
      * Helia will periodically re-provide every previously provided CID. Use this
      * method to no longer re-provide the passed CID.
@@ -161,10 +189,12 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * await contentRouting.cancelReprovide(cid)
+     * await contentRouting.cancelReprovide(cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    cancelReprovide(key: CID, options?: AbortOptions): Promise<void>;
+    cancelReprovide?(key: CID, options?: AbortOptions): Promise<void>;
     /**
      * Find the providers of the passed CID.
      *
@@ -172,12 +202,14 @@ export interface Routing {
      *
      * ```js
      * // Iterate over the providers found for the given cid
-     * for await (const provider of contentRouting.findProviders(cid)) {
+     * for await (const provider of contentRouting.findProviders(cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })) {
      *  console.log(provider.id, provider.multiaddrs)
      * }
      * ```
      */
-    findProviders(cid: CID, options?: RoutingOptions<RoutingFindProvidersProgressEvents>): AsyncIterable<Provider>;
+    findProviders?(cid: CID, options?: RoutingOptions<RoutingFindProvidersProgressEvents>): AsyncIterable<Provider>;
     /**
      * Puts a value corresponding to the passed key in a way that can later be
      * retrieved by another network peer using the get method.
@@ -186,13 +218,15 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * const key = '/key'
+     * const key = uint8ArrayFromString('/key')
      * const value = uint8ArrayFromString('oh hello there')
      *
-     * await contentRouting.put(key, value)
+     * await contentRouting.put(key, value, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>;
+    put?(key: Uint8Array, value: Uint8Array, options?: RoutingOptions<RoutingPutProgressEvents>): Promise<void>;
     /**
      * Retrieves a value from the network corresponding to the passed key.
      *
@@ -201,11 +235,13 @@ export interface Routing {
      * ```js
      * // ...
      *
-     * const key = '/key'
-     * const value = await contentRouting.get(key)
+     * const key = uint8ArrayFromString('/key')
+     * const value = await contentRouting.get(key, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    get(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>;
+    get?(key: Uint8Array, options?: RoutingOptions<RoutingGetProgressEvents>): Promise<Uint8Array>;
     /**
      * Searches the network for peer info corresponding to the passed peer id.
      *
@@ -213,10 +249,12 @@ export interface Routing {
      *
      * ```js
      * // ...
-     * const peer = await peerRouting.findPeer(peerId, options)
+     * const peer = await peerRouting.findPeer(peerId, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
      * ```
      */
-    findPeer(peerId: PeerId, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<PeerInfo>;
+    findPeer?(peer: CID, options?: RoutingOptions<RoutingFindPeerProgressEvents>): Promise<Peer>;
     /**
      * Search the network for peers that are closer to the passed key. Peer
      * info should be yielded in ever-increasing closeness to the key.
@@ -225,11 +263,14 @@ export interface Routing {
      *
      * ```js
      * // Iterate over the closest peers found for the given key
-     * for await (const peer of peerRouting.getClosestPeers(key)) {
+     * for await (const peer of peerRouting.getClosestPeers(key, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })) {
      *   console.log(peer.id, peer.multiaddrs)
      * }
      * ```
      */
-    getClosestPeers(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<PeerInfo>;
+    getClosestPeers?(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<Peer>;
 }
+export type Routing = Required<Omit<Router, 'name'>>;
 //# sourceMappingURL=routing.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,aAAa,GAAG,GAAG,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,YAAY;IAC3H;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uCAAuC;IACtD,OAAO,EAAE,qBAAqB,CAAA;IAC9B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,QAAQ,GAAG;QACnB,SAAS,EAAE,CAAC,6BAA6B,CAAC,CAAA;KAC3C,CAAA;CACF;AAED,MAAM,WAAW,gDAAgD;IAC/D,OAAO,EAAE,uBAAuB,CAAA;IAChC,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,QAAQ,GAAG;QACnB,OAAO,EAAE,wBAAwB,CAAA;QACjC,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,MAAM,iCAAiC,GAAG,uCAAuC,GAAG,gDAAgD,GAAG,kCAAkC,CAAA;AAE/K,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,GACnF,aAAa,CAAC,uCAAuC,EAAE,iCAAiC,CAAC,GACzF,aAAa,CAAC,kCAAkC,EAAE,4BAA4B,CAAC,GAC/E,6BAA6B,CAAA;AAE/B,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,4BAA4B,GACtC,aAAa,CAAC,6BAA6B,EAAE,wBAAwB,CAAC,GACtE,aAAa,CAAC,2BAA2B,EAAE,sBAAsB,CAAC,CAAA;AAEpE,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,sCAAsC,EAAE,gCAAgC,CAAC,GACvF,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,CAAA;AAErF,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,6BAA6B,GACvC,aAAa,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,GACzE,aAAa,CAAC,6BAA6B,EAAE,uBAAuB,CAAC,CAAA;AAEvE,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,uCAAuC,EAAE,gCAAgC,CAAC,GACxF,aAAa,CAAC,qCAAqC,EAAE,8BAA8B,CAAC,CAAA;AAEtF,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;OAUG;IACH,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAExF;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhE;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE9G;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1G;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEpG;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;CAC1H"}
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,aAAa,GAAG,GAAG,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC;IAC7G;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IAEvB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uCAAuC;IACtD,OAAO,EAAE,qBAAqB,CAAA;IAC9B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,GAAG;QACf,SAAS,EAAE,CAAC,6BAA6B,CAAC,CAAA;KAC3C,CAAA;CACF;AAED,MAAM,WAAW,gDAAgD;IAC/D,OAAO,EAAE,uBAAuB,CAAA;IAChC,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,GAAG;QACf,OAAO,EAAE,wBAAwB,CAAA;QACjC,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,CAAA;CACf;AAED,MAAM,MAAM,iCAAiC,GAAG,uCAAuC,GAAG,gDAAgD,GAAG,kCAAkC,CAAA;AAE/K,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,GACnF,aAAa,CAAC,uCAAuC,EAAE,iCAAiC,CAAC,GACzF,aAAa,CAAC,kCAAkC,EAAE,4BAA4B,CAAC,GAC/E,6BAA6B,CAAA;AAE/B,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,4BAA4B,GACtC,aAAa,CAAC,6BAA6B,EAAE,wBAAwB,CAAC,GACtE,aAAa,CAAC,2BAA2B,EAAE,sBAAsB,CAAC,CAAA;AAEpE,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,sCAAsC,EAAE,gCAAgC,CAAC,GACvF,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,CAAA;AAErF,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,MAAM,6BAA6B,GACvC,aAAa,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,GACzE,aAAa,CAAC,6BAA6B,EAAE,uBAAuB,CAAC,CAAA;AAEvE,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,uCAAuC,EAAE,gCAAgC,CAAC,GACxF,aAAa,CAAC,qCAAqC,EAAE,8BAA8B,CAAC,CAAA;AAEtF,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzF;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE/G;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3G;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE9F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5F;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;CACvH;AAED,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "6.2.0",
+  "version": "6.2.1-17530ed8",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",
@@ -45,19 +45,23 @@
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
-      "import": "./dist/src/index.js"
+      "import": "./dist/src/index.js",
+      "module-sync": "./dist/src/index.js"
     },
     "./blocks": {
       "types": "./dist/src/blocks.d.ts",
-      "import": "./dist/src/blocks.js"
+      "import": "./dist/src/blocks.js",
+      "module-sync": "./dist/src/blocks.js"
     },
     "./pins": {
       "types": "./dist/src/pins.d.ts",
-      "import": "./dist/src/pins.js"
+      "import": "./dist/src/pins.js",
+      "module-sync": "./dist/src/pins.js"
     },
     "./routing": {
       "types": "./dist/src/routing.d.ts",
-      "import": "./dist/src/routing.js"
+      "import": "./dist/src/routing.js",
+      "module-sync": "./dist/src/routing.js"
     }
   },
   "scripts": {
@@ -68,17 +72,21 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^3.2.0",
-    "@multiformats/dns": "^1.0.9",
-    "@multiformats/multiaddr": "^13.0.1",
-    "interface-blockstore": "^6.0.1",
-    "interface-datastore": "^9.0.2",
-    "interface-store": "^7.0.0",
-    "multiformats": "^13.4.1",
-    "progress-events": "^1.0.1"
+    "@ipshipyard/crypto": "^1.1.0",
+    "@ipshipyard/keychain": "^1.0.2",
+    "@libp2p/interface": "^3.2.3",
+    "@multiformats/dns": "^1.0.13",
+    "@multiformats/multiaddr": "^13.0.3",
+    "abort-error": "^1.0.2",
+    "birnam": "^1.0.0",
+    "interface-blockstore": "^7.0.1",
+    "interface-datastore": "^10.0.1",
+    "main-event": "^1.0.4",
+    "multiformats": "^14.0.0",
+    "progress-events": "^1.1.0"
   },
   "devDependencies": {
-    "aegir": "^47.0.22"
+    "aegir": "^48.0.11"
   },
   "sideEffects": false
 }

package/src/blocks.ts

@@ -1,8 +1,7 @@
 import type { RoutingFindProvidersProgressEvents } from './routing.ts'
-import type { PeerId } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
+import type { AbortOptions } from 'abort-error'
 import type { Blockstore } from 'interface-blockstore'
-import type { AbortOptions } from 'interface-store'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
@@ -17,7 +16,7 @@ export interface ProviderOptions {
    * child blocks, a `findProviders` routing query will be run to find peers
    * that can supply the blocks.
    */
-  providers?: Array<PeerId | Multiaddr | Multiaddr[]>
+  providers?: Array<CID | Multiaddr | Multiaddr[]>
 }
 
 /**
@@ -26,7 +25,7 @@ export interface ProviderOptions {
 export interface BlockBrokerConnectProgressEvent {
   broker: string
   type: 'connect'
-  provider: PeerId
+  provider: CID
   cid: CID
 }
 
@@ -36,7 +35,7 @@ export interface BlockBrokerConnectProgressEvent {
 export interface BlockBrokerConnectedProgressEvent {
   broker: string
   type: 'connected'
-  provider: PeerId
+  provider: CID
   address: Multiaddr
   cid: CID
 }
@@ -47,7 +46,7 @@ export interface BlockBrokerConnectedProgressEvent {
 export interface BlockBrokerRequestBlockProgressEvent {
   broker: string
   type: 'request-block'
-  provider: PeerId
+  provider: CID
   cid: CID
 }
 
@@ -57,7 +56,7 @@ export interface BlockBrokerRequestBlockProgressEvent {
 export interface BlockBrokerReceiveBlockProgressEvent {
   broker: string
   type: 'receive-block'
-  provider: PeerId
+  provider: CID
   cid: CID
 }
 
@@ -151,7 +150,7 @@ ProgressOptions<DeleteBlockProgressEvents>, ProgressOptions<DeleteManyBlocksProg
    * Adds a new peer to the session if they are supported and are either
    * not already in the session and have not been evicted previously.
    */
-  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
+  addPeer (peer: CID | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
 }
 
 export interface BlockRetrievalOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents>, ProviderOptions {
@@ -233,7 +232,7 @@ export interface SessionBlockBroker<RetrieveProgressEvents extends ProgressEvent
    * Adds a new peer to the session if they are supported and are either
    * not already in the session and have not been evicted previously.
    */
-  addPeer (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
+  addPeer (peer: CID | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<void>
 }
 
 export const DEFAULT_SESSION_MIN_PROVIDERS = 1

package/src/errors.ts

@@ -42,3 +42,8 @@ export class InvalidCodecError extends Error {
     this.name = 'InvalidCodecError'
   }
 }
+
+export class UnknownCryptoError extends Error {
+  static name = 'UnknownCryptoError'
+  name = 'UnknownCryptoError'
+}

package/src/index.ts

@@ -14,35 +14,50 @@
  * ```
  */
 
-import type { Blocks } from './blocks.ts'
+import type { BlockBroker, Blocks } from './blocks.ts'
 import type { Pins } from './pins.ts'
-import type { Routing } from './routing.ts'
-import type { AbortOptions, ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'
+import type { Router, Routing } from './routing.ts'
+import type { CryptoLoader, Keychain } from '@ipshipyard/keychain'
+import type { Metrics } from '@libp2p/interface'
 import type { DNS } from '@multiformats/dns'
+import type { AbortOptions } from 'abort-error'
+import type { ComponentLogger } from 'birnam'
 import type { Datastore } from 'interface-datastore'
-import type { Await } from 'interface-store'
+import type { TypedEventEmitter } from 'main-event'
 import type { BlockCodec, MultihashHasher } from 'multiformats'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
-export type { Await, AwaitIterable } from 'interface-store'
-
 export interface CodecLoader {
-  <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>
+  <T = any, Code extends number = any>(code: Code, options?: AbortOptions): BlockCodec<Code, T> | Promise<BlockCodec<Code, T>>
 }
 
 export interface HasherLoader {
-  (code: number): Await<MultihashHasher>
+  (code: number, options?: AbortOptions): MultihashHasher | Promise<MultihashHasher>
+}
+
+export type { CryptoLoader, Keychain } from '@ipshipyard/keychain'
+export type { Crypto, PrivateKey, PublicKey } from '@ipshipyard/crypto'
+export { isPrivateKey, isPublicKey } from '@ipshipyard/crypto'
+
+export interface NodeInfo {
+  name: string
+  version: string
+}
+
+export interface HeliaMixin<Start extends Helia = Helia, Stop = Start> {
+  start?(helia: Start): Promise<void> | void
+  stop?(helia: Stop): Promise<void> | void
 }
 
 /**
  * The API presented by a Helia node
  */
-export interface Helia<T extends Libp2p = Libp2p> {
+export interface Helia {
   /**
-   * The libp2p instance
+   * Runtime information about the node
    */
-  libp2p: T
+  info: NodeInfo
 
   /**
    * Where the blocks are stored
@@ -57,7 +72,12 @@ export interface Helia<T extends Libp2p = Libp2p> {
   /**
    * Event emitter for Helia start and stop events
    */
-  events: TypedEventEmitter<HeliaEvents<T>>
+  events: TypedEventEmitter<HeliaEvents<this>>
+
+  /**
+   * Secure storage for private keys
+   */
+  keychain: Keychain
 
   /**
    * Pinning operations for blocks in the blockstore
@@ -87,15 +107,20 @@ export interface Helia<T extends Libp2p = Libp2p> {
    */
   metrics?: Metrics
 
+  /**
+   * The current status of the Helia node
+   */
+  status: 'starting' | 'started' | 'stopping' | 'stopped'
+
   /**
    * Starts the Helia node
    */
-  start(): Promise<void>
+  start(options?: AbortOptions): Promise<this>
 
   /**
    * Stops the Helia node
    */
-  stop(): Promise<void>
+  stop(options?: AbortOptions): Promise<this>
 
   /**
    * Remove any unpinned blocks from the blockstore
@@ -114,6 +139,36 @@ export interface Helia<T extends Libp2p = Libp2p> {
    * the hasher is being fetched from the network.
    */
   getHasher: HasherLoader
+
+  /**
+   * Cryptography implementations securely sign and verify data
+   */
+  getCrypto: CryptoLoader
+
+  /**
+   * Returns `true` if a router with the passed name has been configured
+   */
+  hasRouter (name: string): boolean
+
+  /**
+   * Add a router
+   */
+  addRouter(router: Router): void
+
+  /**
+   * Returns `true` if a block broker with the passed name has been configured
+   */
+  hasBlockBroker (name: string): boolean
+
+  /**
+   * Add a block broker
+   */
+  addBlockBroker(blockBroker: BlockBroker): void
+
+  /**
+   * Add a mixin to extend runtime functionality
+   */
+  addMixin<T extends Helia = Helia & Record<string, any>>(mixin: HeliaMixin<T>): void
 }
 
 export type GcEvents =
@@ -124,7 +179,7 @@ export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 
 }
 
-export interface HeliaEvents<T extends Libp2p = Libp2p> {
+export interface HeliaEvents<H extends Helia = Helia> {
   /**
    * This event notifies listeners that the node has started
    *
@@ -134,7 +189,7 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
    * })
    * ```
    */
-  start: CustomEvent<Helia<T>>
+  start: CustomEvent<H>
 
   /**
    * This event notifies listeners that the node has stopped
@@ -145,7 +200,7 @@ export interface HeliaEvents<T extends Libp2p = Libp2p> {
    * })
    * ```
    */
-  stop: CustomEvent<Helia<T>>
+  stop: CustomEvent<H>
 }
 
 export * from './blocks.ts'

package/src/pins.ts

@@ -1,5 +1,5 @@
 import type { GetBlockProgressEvents } from './blocks.ts'
-import type { AbortOptions } from '@libp2p/interface'
+import type { AbortOptions } from 'abort-error'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'