@helia/interface 3.0.1 → 4.0.0-2d965be

package/README.md

@@ -11,6 +11,20 @@
 
 > The Helia API
 
+# About
+
+The API defined by a Helia node
+
+## Example
+
+```typescript
+import type { Helia } from '@helia/interface'
+
+export function doSomething(helia: Helia) {
+  // use helia node functions here
+}
+```
+
 # Install
 
 ```console

package/dist/index.min.js

@@ -1,3 +1,3 @@
 (function (root, factory) {(typeof module === 'object' && module.exports) ? module.exports = factory() : root.HeliaInterface = factory()}(typeof self !== 'undefined' ? self : this, function () {
-"use strict";var HeliaInterface=(()=>{var t=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var d=(o,e,x,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let p of b(e))!c.call(o,p)&&p!==x&&t(o,p,{get:()=>e[p],enumerable:!(r=a(e,p))||r.enumerable});return o};var f=o=>d(t({},"__esModule",{value:!0}),o);var g={};return f(g);})();
+"use strict";var HeliaInterface=(()=>{var t=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var a=Object.prototype.hasOwnProperty;var b=(r,o,x,p)=>{if(o&&typeof o=="object"||typeof o=="function")for(let e of m(o))!a.call(r,e)&&e!==x&&t(r,e,{get:()=>o[e],enumerable:!(p=f(o,e))||p.enumerable});return r};var c=r=>b(t({},"__esModule",{value:!0}),r);var d={};return c(d);})();
 return HeliaInterface}));

package/dist/src/blocks.d.ts

@@ -1,17 +1,16 @@
 import type { Blockstore } from 'interface-blockstore';
 import type { AbortOptions } from 'interface-store';
-import type { BitswapNotifyProgressEvents, BitswapWantProgressEvents } from 'ipfs-bitswap';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 export interface Pair {
     cid: CID;
     block: Uint8Array;
 }
-export type HasBlockProgressEvents = ProgressEvent<'blocks:put:duplicate', CID> | ProgressEvent<'blocks:put:providers:notify', CID> | ProgressEvent<'blocks:put:blockstore:put', CID> | BitswapNotifyProgressEvents;
-export type PutBlockProgressEvents = ProgressEvent<'blocks:put:duplicate', CID> | ProgressEvent<'blocks:put:providers:notify', CID> | ProgressEvent<'blocks:put:blockstore:put', CID> | BitswapNotifyProgressEvents;
-export type PutManyBlocksProgressEvents = ProgressEvent<'blocks:put-many:duplicate', CID> | ProgressEvent<'blocks:put-many:providers:notify', CID> | ProgressEvent<'blocks:put-many:blockstore:put-many'> | BitswapNotifyProgressEvents;
-export type GetBlockProgressEvents = ProgressEvent<'blocks:get:providers:want', CID> | ProgressEvent<'blocks:get:blockstore:get', CID> | ProgressEvent<'blocks:get:blockstore:put', CID> | BitswapWantProgressEvents;
-export type GetManyBlocksProgressEvents = ProgressEvent<'blocks:get-many:blockstore:get-many'> | ProgressEvent<'blocks:get-many:providers:want', CID> | ProgressEvent<'blocks:get-many:blockstore:put', CID> | BitswapWantProgressEvents;
+export type HasBlockProgressEvents = ProgressEvent<'blocks:put:duplicate', CID> | ProgressEvent<'blocks:put:providers:notify', CID> | ProgressEvent<'blocks:put:blockstore:put', CID>;
+export type PutBlockProgressEvents = ProgressEvent<'blocks:put:duplicate', CID> | ProgressEvent<'blocks:put:providers:notify', CID> | ProgressEvent<'blocks:put:blockstore:put', CID>;
+export type PutManyBlocksProgressEvents = ProgressEvent<'blocks:put-many:duplicate', CID> | ProgressEvent<'blocks:put-many:providers:notify', CID> | ProgressEvent<'blocks:put-many:blockstore:put-many'>;
+export type GetBlockProgressEvents = ProgressEvent<'blocks:get:providers:want', CID> | ProgressEvent<'blocks:get:blockstore:get', CID> | ProgressEvent<'blocks:get:blockstore:put', CID>;
+export type GetManyBlocksProgressEvents = ProgressEvent<'blocks:get-many:blockstore:get-many'> | ProgressEvent<'blocks:get-many:providers:want', CID> | ProgressEvent<'blocks:get-many:blockstore:put', CID>;
 export type GetAllBlocksProgressEvents = ProgressEvent<'blocks:get-all:blockstore:get-many'>;
 export type DeleteBlockProgressEvents = ProgressEvent<'blocks:delete:blockstore:delete', CID>;
 export type DeleteManyBlocksProgressEvents = ProgressEvent<'blocks:delete-many:blockstore:delete-many'>;

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

@@ -1 +1 @@
-{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,2BAA2B,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAA;AAC1F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,IAAI;IACnB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,2BAA2B,CAAA;AAE7B,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,2BAA2B,CAAA;AAE7B,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,kCAAkC,EAAE,GAAG,CAAC,GACtD,aAAa,CAAC,qCAAqC,CAAC,GACpD,2BAA2B,CAAA;AAE7B,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,yBAAyB,CAAA;AAE3B,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,GACpD,yBAAyB,CAAA;AAE3B,MAAM,MAAM,0BAA0B,GACpC,aAAa,CAAC,oCAAoC,CAAC,CAAA;AAErD,MAAM,MAAM,yBAAyB,GACnC,aAAa,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;AAEvD,MAAM,MAAM,8BAA8B,GACxC,aAAa,CAAC,2CAA2C,CAAC,CAAA;AAE5D,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAClF,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAC,2BAA2B,CAAC,EACrF,iBAAiB,GAAG,eAAe,CAAC,sBAAsB,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,2BAA2B,CAAC,EAAE,eAAe,CAAC,0BAA0B,CAAC,EAC1K,eAAe,CAAC,yBAAyB,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,CAC1F;CAEA;AAED,MAAM,MAAM,qBAAqB,CAAC,kBAAkB,SAAS,eAAe,GAAG,eAAe,IAAI,YAAY,GAAG,kBAAkB,GAAG;IACpI;;;;;OAKG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9C,CAAA;AAED,MAAM,WAAW,cAAc,CAAC,kBAAkB,SAAS,eAAe,GAAG,eAAe;IAC1F;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CAC7F;AAED,MAAM,WAAW,cAAc,CAAC,qBAAqB,SAAS,eAAe,GAAG,eAAe;IAC7F;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;CAC7E;AAED,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,CAAA"}
+{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,IAAI;IACnB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAC1C,aAAa,CAAC,6BAA6B,EAAE,GAAG,CAAC,GACjD,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,kCAAkC,EAAE,GAAG,CAAC,GACtD,aAAa,CAAC,qCAAqC,CAAC,CAAA;AAEtD,MAAM,MAAM,sBAAsB,GAChC,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,GAC/C,aAAa,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;AAEjD,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,GACpD,aAAa,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAA;AAEtD,MAAM,MAAM,0BAA0B,GACpC,aAAa,CAAC,oCAAoC,CAAC,CAAA;AAErD,MAAM,MAAM,yBAAyB,GACnC,aAAa,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;AAEvD,MAAM,MAAM,8BAA8B,GACxC,aAAa,CAAC,2CAA2C,CAAC,CAAA;AAE5D,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAClF,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAC,2BAA2B,CAAC,EACrF,iBAAiB,GAAG,eAAe,CAAC,sBAAsB,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,2BAA2B,CAAC,EAAE,eAAe,CAAC,0BAA0B,CAAC,EAC1K,eAAe,CAAC,yBAAyB,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,CAC1F;CAEA;AAED,MAAM,MAAM,qBAAqB,CAAC,kBAAkB,SAAS,eAAe,GAAG,eAAe,IAAI,YAAY,GAAG,kBAAkB,GAAG;IACpI;;;;;OAKG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9C,CAAA;AAED,MAAM,WAAW,cAAc,CAAC,kBAAkB,SAAS,eAAe,GAAG,eAAe;IAC1F;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CAC7F;AAED,MAAM,WAAW,cAAc,CAAC,qBAAqB,SAAS,eAAe,GAAG,eAAe;IAC7F;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;CAC7E;AAED,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,CAAA"}

package/dist/src/index.d.ts

@@ -15,19 +15,17 @@
  */
 import type { Blocks } from './blocks.js';
 import type { Pins } from './pins.js';
-import type { Libp2p, AbortOptions, ComponentLogger } from '@libp2p/interface';
+import type { Routing } from './routing.js';
+import type { AbortOptions, ComponentLogger } from '@libp2p/interface';
 import type { Datastore } from 'interface-datastore';
+import type { MultihashHasher } from 'multiformats';
 import type { CID } from 'multiformats/cid';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 export type { Await, AwaitIterable } from 'interface-store';
 /**
- * The API presented by a Helia node.
+ * The API presented by a Helia node
  */
-export interface Helia<T = Libp2p> {
-    /**
-     * The underlying libp2p node
-     */
-    libp2p: T;
+export interface Helia {
     /**
      * Where the blocks are stored
      */
@@ -44,6 +42,21 @@ export interface Helia<T = Libp2p> {
      * A logging component that can be reused by consumers
      */
     logger: ComponentLogger;
+    /**
+     * The routing component allows performing operations such as looking up
+     * content providers, information about peers, etc.
+     */
+    routing: Routing;
+    /**
+     * DAGWalkers are codec-specific implementations that know how to yield all
+     * CIDs contained within a block that corresponds to that codec.
+     */
+    dagWalkers: Record<number, DAGWalker>;
+    /**
+     * Hashers can be used to hash a piece of data with the specified hashing
+     * algorithm.
+     */
+    hashers: Record<number, MultihashHasher>;
     /**
      * Starts the Helia node
      */
@@ -60,4 +73,14 @@ export interface Helia<T = Libp2p> {
 export type GcEvents = ProgressEvent<'helia:gc:deleted', CID> | ProgressEvent<'helia:gc:error', Error>;
 export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 }
+/**
+ * DAGWalkers take a block and yield CIDs encoded in that block
+ */
+export interface DAGWalker {
+    codec: number;
+    walk(block: Uint8Array): Generator<CID, void, undefined>;
+}
+export * from './blocks.js';
+export * from './pins.js';
+export * from './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;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,MAAM;IAC/B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IAEvB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IAEvB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAErC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IAExC;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACzD;AAED,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/index.js

@@ -13,5 +13,7 @@
  * }
  * ```
  */
-export {};
+export * from './blocks.js';
+export * from './pins.js';
+export * from './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;;;;;;;;;;;;;;GAcG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAuFH,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/routing.d.ts

@@ -0,0 +1,128 @@
+import type { AbortOptions, PeerId, PeerInfo } from '@libp2p/interface';
+import type { CID } from 'multiformats/cid';
+import type { ProgressOptions } from 'progress-events';
+/**
+ * When a routing operation involves reading values, these options allow
+ * controlling where the values are read from. Some implementations support a
+ * local cache that may be used in preference over network calls, for example
+ * when a record has a TTL.
+ */
+export interface RoutingOptions extends AbortOptions, ProgressOptions {
+    /**
+     * Pass `false` to not use the network
+     *
+     * @default true
+     */
+    useNetwork?: boolean;
+    /**
+     * Pass `false` to not use cached values
+     *
+     * @default true
+     */
+    useCache?: boolean;
+    /**
+     * Pass `false` to not perform validation
+     *
+     * @default true
+     */
+    validate?: boolean;
+}
+/**
+ * A provider can supply the content for a CID
+ */
+export interface Provider extends PeerInfo {
+    /**
+     * If present these are the methods that the peer can supply the content via.
+     *
+     * If not present the caller should attempt to dial the remote peer and run
+     * the identify protocol to discover how to retrieve the content.
+     *
+     * Example values are (but not limited to):
+     *
+     * - transport-graphsync-filecoinv1
+     * - transport-ipfs-gateway-http
+     * - transport-bitswap
+     */
+    protocols?: string[];
+}
+export interface Routing {
+    /**
+     * The implementation of this method should ensure that network peers know the
+     * caller can provide content that corresponds to the passed CID.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     * await contentRouting.provide(cid)
+     * ```
+     */
+    provide(cid: CID, options?: RoutingOptions): Promise<void>;
+    /**
+     * Find the providers of the passed CID.
+     *
+     * @example
+     *
+     * ```js
+     * // Iterate over the providers found for the given cid
+     * for await (const provider of contentRouting.findProviders(cid)) {
+     *  console.log(provider.id, provider.multiaddrs)
+     * }
+     * ```
+     */
+    findProviders(cid: CID, options?: RoutingOptions): 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.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     * const key = '/key'
+     * const value = uint8ArrayFromString('oh hello there')
+     *
+     * await contentRouting.put(key, value)
+     * ```
+     */
+    put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions): Promise<void>;
+    /**
+     * Retrieves a value from the network corresponding to the passed key.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     *
+     * const key = '/key'
+     * const value = await contentRouting.get(key)
+     * ```
+     */
+    get(key: Uint8Array, options?: RoutingOptions): Promise<Uint8Array>;
+    /**
+     * Searches the network for peer info corresponding to the passed peer id.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     * const peer = await peerRouting.findPeer(peerId, options)
+     * ```
+     */
+    findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>;
+    /**
+     * Search the network for peers that are closer to the passed key. Peer
+     * info should be yielded in ever-increasing closeness to the key.
+     *
+     * @example
+     *
+     * ```js
+     * // Iterate over the closest peers found for the given key
+     * for await (const peer of peerRouting.getClosestPeers(key)) {
+     *   console.log(peer.id, peer.multiaddrs)
+     * }
+     * ```
+     */
+    getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncIterable<PeerInfo>;
+}
+//# sourceMappingURL=routing.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACvE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,eAAe;IACnE;;;;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;CACrB;AAED,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE1E;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhF;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnE;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAErE;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;CACpF"}

package/dist/src/routing.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=routing.js.map

package/dist/src/routing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "3.0.1",
+  "version": "4.0.0-2d965be",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",
@@ -70,15 +70,14 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^1.1.1",
-    "interface-blockstore": "^5.2.7",
-    "interface-datastore": "^8.2.2",
-    "interface-store": "^5.1.5",
-    "ipfs-bitswap": "^20.0.0",
-    "multiformats": "^13.0.0",
+    "@libp2p/interface": "^1.1.2",
+    "interface-blockstore": "^5.2.9",
+    "interface-datastore": "^8.2.10",
+    "interface-store": "^5.1.7",
+    "multiformats": "^13.0.1",
     "progress-events": "^1.0.0"
   },
   "devDependencies": {
-    "aegir": "^42.1.0"
+    "aegir": "^42.2.2"
   }
 }

package/src/blocks.ts

@@ -1,6 +1,5 @@
 import type { Blockstore } from 'interface-blockstore'
 import type { AbortOptions } from 'interface-store'
-import type { BitswapNotifyProgressEvents, BitswapWantProgressEvents } from 'ipfs-bitswap'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
@@ -12,32 +11,27 @@ export interface Pair {
 export type HasBlockProgressEvents =
   ProgressEvent<'blocks:put:duplicate', CID> |
   ProgressEvent<'blocks:put:providers:notify', CID> |
-  ProgressEvent<'blocks:put:blockstore:put', CID> |
-  BitswapNotifyProgressEvents
+  ProgressEvent<'blocks:put:blockstore:put', CID>
 
 export type PutBlockProgressEvents =
   ProgressEvent<'blocks:put:duplicate', CID> |
   ProgressEvent<'blocks:put:providers:notify', CID> |
-  ProgressEvent<'blocks:put:blockstore:put', CID> |
-  BitswapNotifyProgressEvents
+  ProgressEvent<'blocks:put:blockstore:put', CID>
 
 export type PutManyBlocksProgressEvents =
   ProgressEvent<'blocks:put-many:duplicate', CID> |
   ProgressEvent<'blocks:put-many:providers:notify', CID> |
-  ProgressEvent<'blocks:put-many:blockstore:put-many'> |
-  BitswapNotifyProgressEvents
+  ProgressEvent<'blocks:put-many:blockstore:put-many'>
 
 export type GetBlockProgressEvents =
   ProgressEvent<'blocks:get:providers:want', CID> |
   ProgressEvent<'blocks:get:blockstore:get', CID> |
-  ProgressEvent<'blocks:get:blockstore:put', CID> |
-  BitswapWantProgressEvents
+  ProgressEvent<'blocks:get:blockstore:put', CID>
 
 export type GetManyBlocksProgressEvents =
   ProgressEvent<'blocks:get-many:blockstore:get-many'> |
   ProgressEvent<'blocks:get-many:providers:want', CID> |
-  ProgressEvent<'blocks:get-many:blockstore:put', CID> |
-  BitswapWantProgressEvents
+  ProgressEvent<'blocks:get-many:blockstore:put', CID>
 
 export type GetAllBlocksProgressEvents =
   ProgressEvent<'blocks:get-all:blockstore:get-many'>

package/src/index.ts

@@ -16,22 +16,19 @@
 
 import type { Blocks } from './blocks.js'
 import type { Pins } from './pins.js'
-import type { Libp2p, AbortOptions, ComponentLogger } from '@libp2p/interface'
+import type { Routing } from './routing.js'
+import type { AbortOptions, ComponentLogger } from '@libp2p/interface'
 import type { Datastore } from 'interface-datastore'
+import type { MultihashHasher } from 'multiformats'
 import type { CID } from 'multiformats/cid'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
 
 export type { Await, AwaitIterable } from 'interface-store'
 
 /**
- * The API presented by a Helia node.
+ * The API presented by a Helia node
  */
-export interface Helia<T = Libp2p> {
-  /**
-   * The underlying libp2p node
-   */
-  libp2p: T
-
+export interface Helia {
   /**
    * Where the blocks are stored
    */
@@ -52,6 +49,24 @@ export interface Helia<T = Libp2p> {
    */
   logger: ComponentLogger
 
+  /**
+   * The routing component allows performing operations such as looking up
+   * content providers, information about peers, etc.
+   */
+  routing: Routing
+
+  /**
+   * DAGWalkers are codec-specific implementations that know how to yield all
+   * CIDs contained within a block that corresponds to that codec.
+   */
+  dagWalkers: Record<number, DAGWalker>
+
+  /**
+   * Hashers can be used to hash a piece of data with the specified hashing
+   * algorithm.
+   */
+  hashers: Record<number, MultihashHasher>
+
   /**
    * Starts the Helia node
    */
@@ -75,3 +90,15 @@ export type GcEvents =
 export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 
 }
+
+/**
+ * DAGWalkers take a block and yield CIDs encoded in that block
+ */
+export interface DAGWalker {
+  codec: number
+  walk(block: Uint8Array): Generator<CID, void, undefined>
+}
+
+export * from './blocks.js'
+export * from './pins.js'
+export * from './routing.js'

package/src/routing.ts

@@ -0,0 +1,137 @@
+import type { AbortOptions, PeerId, PeerInfo } from '@libp2p/interface'
+import type { CID } from 'multiformats/cid'
+import type { ProgressOptions } from 'progress-events'
+
+/**
+ * When a routing operation involves reading values, these options allow
+ * controlling where the values are read from. Some implementations support a
+ * local cache that may be used in preference over network calls, for example
+ * when a record has a TTL.
+ */
+export interface RoutingOptions extends AbortOptions, ProgressOptions {
+  /**
+   * Pass `false` to not use the network
+   *
+   * @default true
+   */
+  useNetwork?: boolean
+
+  /**
+   * Pass `false` to not use cached values
+   *
+   * @default true
+   */
+  useCache?: boolean
+
+  /**
+   * Pass `false` to not perform validation
+   *
+   * @default true
+   */
+  validate?: boolean
+}
+
+/**
+ * A provider can supply the content for a CID
+ */
+export interface Provider extends PeerInfo {
+  /**
+   * If present these are the methods that the peer can supply the content via.
+   *
+   * If not present the caller should attempt to dial the remote peer and run
+   * the identify protocol to discover how to retrieve the content.
+   *
+   * Example values are (but not limited to):
+   *
+   * - transport-graphsync-filecoinv1
+   * - transport-ipfs-gateway-http
+   * - transport-bitswap
+   */
+  protocols?: string[]
+}
+
+export interface Routing {
+  /**
+   * The implementation of this method should ensure that network peers know the
+   * caller can provide content that corresponds to the passed CID.
+   *
+   * @example
+   *
+   * ```js
+   * // ...
+   * await contentRouting.provide(cid)
+   * ```
+   */
+  provide(cid: CID, options?: RoutingOptions): Promise<void>
+
+  /**
+   * Find the providers of the passed CID.
+   *
+   * @example
+   *
+   * ```js
+   * // Iterate over the providers found for the given cid
+   * for await (const provider of contentRouting.findProviders(cid)) {
+   *  console.log(provider.id, provider.multiaddrs)
+   * }
+   * ```
+   */
+  findProviders(cid: CID, options?: RoutingOptions): 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.
+   *
+   * @example
+   *
+   * ```js
+   * // ...
+   * const key = '/key'
+   * const value = uint8ArrayFromString('oh hello there')
+   *
+   * await contentRouting.put(key, value)
+   * ```
+   */
+  put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions): Promise<void>
+
+  /**
+   * Retrieves a value from the network corresponding to the passed key.
+   *
+   * @example
+   *
+   * ```js
+   * // ...
+   *
+   * const key = '/key'
+   * const value = await contentRouting.get(key)
+   * ```
+   */
+  get(key: Uint8Array, options?: RoutingOptions): Promise<Uint8Array>
+
+  /**
+   * Searches the network for peer info corresponding to the passed peer id.
+   *
+   * @example
+   *
+   * ```js
+   * // ...
+   * const peer = await peerRouting.findPeer(peerId, options)
+   * ```
+   */
+  findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>
+
+  /**
+   * Search the network for peers that are closer to the passed key. Peer
+   * info should be yielded in ever-increasing closeness to the key.
+   *
+   * @example
+   *
+   * ```js
+   * // Iterate over the closest peers found for the given key
+   * for await (const peer of peerRouting.getClosestPeers(key)) {
+   *   console.log(peer.id, peer.multiaddrs)
+   * }
+   * ```
+   */
+  getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncIterable<PeerInfo>
+}

package/dist/typedoc-urls.json

@@ -1,54 +0,0 @@
-{
-  "AddOptions": "https://ipfs.github.io/helia/interfaces/helia.AddOptions.html",
-  "./pins:AddOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.AddOptions.html",
-  "BlockAnnouncer": "https://ipfs.github.io/helia/interfaces/helia.BlockAnnouncer.html",
-  "./blocks:BlockAnnouncer": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.BlockAnnouncer.html",
-  "BlockRetriever": "https://ipfs.github.io/helia/interfaces/helia.BlockRetriever.html",
-  "./blocks:BlockRetriever": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.BlockRetriever.html",
-  "Blocks": "https://ipfs.github.io/helia/interfaces/helia.Blocks.html",
-  "./blocks:Blocks": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.Blocks.html",
-  "GCOptions": "https://ipfs.github.io/helia/interfaces/helia.GCOptions.html",
-  ".:GCOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.index.GCOptions.html",
-  "GetOfflineOptions": "https://ipfs.github.io/helia/interfaces/helia.GetOfflineOptions.html",
-  "./blocks:GetOfflineOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.GetOfflineOptions.html",
-  "Helia": "https://ipfs.github.io/helia/interfaces/helia.Helia.html",
-  ".:Helia": "https://ipfs.github.io/helia/interfaces/_helia_interface.index.Helia.html",
-  "IsPinnedOptions": "https://ipfs.github.io/helia/interfaces/helia.IsPinnedOptions.html",
-  "./pins:IsPinnedOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.IsPinnedOptions.html",
-  "LsOptions": "https://ipfs.github.io/helia/interfaces/helia.LsOptions.html",
-  "./pins:LsOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.LsOptions.html",
-  "Pair": "https://ipfs.github.io/helia/interfaces/helia.Pair.html",
-  "./blocks:Pair": "https://ipfs.github.io/helia/interfaces/_helia_interface.blocks.Pair.html",
-  "Pin": "https://ipfs.github.io/helia/interfaces/helia.Pin.html",
-  "./pins:Pin": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.Pin.html",
-  "Pins": "https://ipfs.github.io/helia/interfaces/helia.Pins.html",
-  "./pins:Pins": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.Pins.html",
-  "RmOptions": "https://ipfs.github.io/helia/interfaces/helia.RmOptions.html",
-  "./pins:RmOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.pins.RmOptions.html",
-  "AddPinEvents": "https://ipfs.github.io/helia/types/helia.AddPinEvents.html",
-  "./pins:AddPinEvents": "https://ipfs.github.io/helia/types/_helia_interface.pins.AddPinEvents.html",
-  "BlockBroker": "https://ipfs.github.io/helia/types/helia.BlockBroker.html",
-  "./blocks:BlockBroker": "https://ipfs.github.io/helia/types/_helia_interface.blocks.BlockBroker.html",
-  "BlockRetrievalOptions": "https://ipfs.github.io/helia/types/helia.BlockRetrievalOptions.html",
-  "./blocks:BlockRetrievalOptions": "https://ipfs.github.io/helia/types/_helia_interface.blocks.BlockRetrievalOptions.html",
-  "DeleteBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.DeleteBlockProgressEvents.html",
-  "./blocks:DeleteBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.DeleteBlockProgressEvents.html",
-  "DeleteManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.DeleteManyBlocksProgressEvents.html",
-  "./blocks:DeleteManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html",
-  "GcEvents": "https://ipfs.github.io/helia/types/helia.GcEvents.html",
-  ".:GcEvents": "https://ipfs.github.io/helia/types/_helia_interface.index.GcEvents.html",
-  "GetAllBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.GetAllBlocksProgressEvents.html",
-  "./blocks:GetAllBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html",
-  "GetBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.GetBlockProgressEvents.html",
-  "./blocks:GetBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.GetBlockProgressEvents.html",
-  "GetManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.GetManyBlocksProgressEvents.html",
-  "./blocks:GetManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html",
-  "HasBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.HasBlockProgressEvents.html",
-  "./blocks:HasBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.HasBlockProgressEvents.html",
-  "PinType": "https://ipfs.github.io/helia/types/helia.PinType.html",
-  "./pins:PinType": "https://ipfs.github.io/helia/types/_helia_interface.pins.PinType.html",
-  "PutBlockProgressEvents": "https://ipfs.github.io/helia/types/helia.PutBlockProgressEvents.html",
-  "./blocks:PutBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.PutBlockProgressEvents.html",
-  "PutManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/helia.PutManyBlocksProgressEvents.html",
-  "./blocks:PutManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html"
-}