@helia/interface 4.3.1-5ff6998 → 4.3.1-9de08ef

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 s=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var E=Object.prototype.hasOwnProperty;var u=(o,r)=>{for(var e in r)s(o,e,{get:r[e],enumerable:!0})},l=(o,r,e,p)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of x(r))!E.call(o,t)&&t!==e&&s(o,t,{get:()=>r[t],enumerable:!(p=m(r,t))||p.enumerable});return o};var d=o=>l(s({},"__esModule",{value:!0}),o);var f={};u(f,{DEFAULT_SESSION_MAX_PROVIDERS:()=>I,DEFAULT_SESSION_MIN_PROVIDERS:()=>S,InsufficientProvidersError:()=>n,NoRoutersAvailableError:()=>a,UnknownCodecError:()=>i,UnknownHashAlgorithmError:()=>c});var S=1,I=5;var n=class extends Error{static name="InsufficientProvidersError";constructor(r="Insufficient providers found"){super(r),this.name="InsufficientProvidersError"}},a=class extends Error{static name="NoRoutersAvailableError";constructor(r="No routers available"){super(r),this.name="NoRoutersAvailableError"}},c=class extends Error{static name="UnknownHashAlgorithmError";constructor(r="Unknown hash algorithm"){super(r),this.name="UnknownHashAlgorithmError"}},i=class extends Error{static name="UnknownCodecError";constructor(r="Unknown codec"){super(r),this.name="UnknownCodecError"}};return d(f);})();
+"use strict";var HeliaInterface=(()=>{var s=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var E=(o,r)=>{for(var t in r)s(o,t,{get:r[t],enumerable:!0})},f=(o,r,t,c)=>{if(r&&typeof r=="object"||typeof r=="function")for(let e of p(r))!x.call(o,e)&&e!==t&&s(o,e,{get:()=>r[e],enumerable:!(c=i(r,e))||c.enumerable});return o};var u=o=>f(s({},"__esModule",{value:!0}),o);var m={};E(m,{DEFAULT_SESSION_MAX_PROVIDERS:()=>l,DEFAULT_SESSION_MIN_PROVIDERS:()=>I,InsufficientProvidersError:()=>n,NoRoutersAvailableError:()=>a});var I=1,l=5;var n=class extends Error{static name="InsufficientProvidersError";constructor(r="Insufficient providers found"){super(r),this.name="InsufficientProvidersError"}},a=class extends Error{static name="NoRoutersAvailableError";constructor(r="No routers available"){super(r),this.name="NoRoutersAvailableError"}};return u(m);})();
 return HeliaInterface}));

package/dist/src/errors.d.ts

@@ -6,12 +6,4 @@ export declare class NoRoutersAvailableError extends Error {
     static name: string;
     constructor(message?: string);
 }
-export declare class UnknownHashAlgorithmError extends Error {
-    static name: string;
-    constructor(message?: string);
-}
-export declare class UnknownCodecError extends Error {
-    static name: string;
-    constructor(message?: string);
-}
 //# sourceMappingURL=errors.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,0BAA2B,SAAQ,KAAK;IACnD,MAAM,CAAC,IAAI,SAA+B;gBAE7B,OAAO,SAAiC;CAItD;AAED,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,MAAM,CAAC,IAAI,SAA4B;gBAE1B,OAAO,SAAyB;CAI9C;AAED,qBAAa,yBAA0B,SAAQ,KAAK;IAClD,MAAM,CAAC,IAAI,SAA8B;gBAE5B,OAAO,SAA2B;CAIhD;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,SAAsB;gBAEpB,OAAO,SAAkB;CAIvC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,0BAA2B,SAAQ,KAAK;IACnD,MAAM,CAAC,IAAI,SAA+B;gBAE7B,OAAO,SAAiC;CAItD;AAED,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,MAAM,CAAC,IAAI,SAA4B;gBAE1B,OAAO,SAAyB;CAI9C"}

package/dist/src/errors.js

@@ -12,18 +12,4 @@ export class NoRoutersAvailableError extends Error {
         this.name = 'NoRoutersAvailableError';
     }
 }
-export class UnknownHashAlgorithmError extends Error {
-    static name = 'UnknownHashAlgorithmError';
-    constructor(message = 'Unknown hash algorithm') {
-        super(message);
-        this.name = 'UnknownHashAlgorithmError';
-    }
-}
-export class UnknownCodecError extends Error {
-    static name = 'UnknownCodecError';
-    constructor(message = 'Unknown codec') {
-        super(message);
-        this.name = 'UnknownCodecError';
-    }
-}
 //# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IACnD,MAAM,CAAC,IAAI,GAAG,4BAA4B,CAAA;IAE1C,YAAa,OAAO,GAAG,8BAA8B;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAA;IAC1C,CAAC;;AAGH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAChD,MAAM,CAAC,IAAI,GAAG,yBAAyB,CAAA;IAEvC,YAAa,OAAO,GAAG,sBAAsB;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAA;IACvC,CAAC;;AAGH,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAClD,MAAM,CAAC,IAAI,GAAG,2BAA2B,CAAA;IAEzC,YAAa,OAAO,GAAG,wBAAwB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAA;IACzC,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAA;IAEjC,YAAa,OAAO,GAAG,eAAe;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IACnD,MAAM,CAAC,IAAI,GAAG,4BAA4B,CAAA;IAE1C,YAAa,OAAO,GAAG,8BAA8B;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAA;IAC1C,CAAC;;AAGH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAChD,MAAM,CAAC,IAAI,GAAG,yBAAyB,CAAA;IAEvC,YAAa,OAAO,GAAG,sBAAsB;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAA;IACvC,CAAC"}

package/dist/src/index.d.ts

@@ -19,17 +19,10 @@ import type { Routing } from './routing.js';
 import type { AbortOptions, ComponentLogger, Metrics } from '@libp2p/interface';
 import type { DNS } from '@multiformats/dns';
 import type { Datastore } from 'interface-datastore';
-import type { Await } from 'interface-store';
-import type { BlockCodec, MultihashHasher } from 'multiformats';
+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';
-export interface CodecLoader {
-    <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>;
-}
-export interface HasherLoader {
-    (code: number): Await<MultihashHasher>;
-}
 /**
  * The API presented by a Helia node
  */
@@ -55,6 +48,16 @@ export interface Helia {
      * 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>;
     /**
      * The DNS property can be used to perform lookups of various record types and
      * will use a resolver appropriate to the current platform.
@@ -77,21 +80,17 @@ export interface Helia {
      * Remove any unpinned blocks from the blockstore
      */
     gc(options?: GCOptions): Promise<void>;
-    /**
-     * Load an IPLD codec. Implementations may return a promise if, for example,
-     * the codec is being fetched from the network.
-     */
-    getCodec: CodecLoader;
-    /**
-     * Hashers can be used to hash a piece of data with the specified hashing
-     * algorithm. Implementations may return a promise if, for example,
-     * the hasher is being fetched from the network.
-     */
-    getHasher: HasherLoader;
 }
 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 './errors.js';
 export * from './pins.js';

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,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/D,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,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,SAAS,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;CAC7E;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,CAAA;CACvC;AAED;;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,GAAG,EAAE,GAAG,CAAA;IAER;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;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;IAEtC;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAA;IAErB;;;;OAIG;IACH,SAAS,EAAE,YAAY,CAAA;CACxB;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,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"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,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,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;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;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,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAsGH,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAoGH,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "4.3.1-5ff6998",
+  "version": "4.3.1-9de08ef",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",

package/src/errors.ts

@@ -15,21 +15,3 @@ export class NoRoutersAvailableError extends Error {
     this.name = 'NoRoutersAvailableError'
   }
 }
-
-export class UnknownHashAlgorithmError extends Error {
-  static name = 'UnknownHashAlgorithmError'
-
-  constructor (message = 'Unknown hash algorithm') {
-    super(message)
-    this.name = 'UnknownHashAlgorithmError'
-  }
-}
-
-export class UnknownCodecError extends Error {
-  static name = 'UnknownCodecError'
-
-  constructor (message = 'Unknown codec') {
-    super(message)
-    this.name = 'UnknownCodecError'
-  }
-}

package/src/index.ts

@@ -20,21 +20,12 @@ import type { Routing } from './routing.js'
 import type { AbortOptions, ComponentLogger, Metrics } from '@libp2p/interface'
 import type { DNS } from '@multiformats/dns'
 import type { Datastore } from 'interface-datastore'
-import type { Await } from 'interface-store'
-import type { BlockCodec, MultihashHasher } from 'multiformats'
+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'
 
-export interface CodecLoader {
-  <T = any, Code extends number = any>(code: Code): Await<BlockCodec<Code, T>>
-}
-
-export interface HasherLoader {
-  (code: number): Await<MultihashHasher>
-}
-
 /**
  * The API presented by a Helia node
  */
@@ -65,6 +56,18 @@ export interface Helia {
    */
   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>
+
   /**
    * The DNS property can be used to perform lookups of various record types and
    * will use a resolver appropriate to the current platform.
@@ -91,19 +94,6 @@ export interface Helia {
    * Remove any unpinned blocks from the blockstore
    */
   gc(options?: GCOptions): Promise<void>
-
-  /**
-   * Load an IPLD codec. Implementations may return a promise if, for example,
-   * the codec is being fetched from the network.
-   */
-  getCodec: CodecLoader
-
-  /**
-   * Hashers can be used to hash a piece of data with the specified hashing
-   * algorithm. Implementations may return a promise if, for example,
-   * the hasher is being fetched from the network.
-   */
-  getHasher: HasherLoader
 }
 
 export type GcEvents =
@@ -114,6 +104,14 @@ 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 './errors.js'
 export * from './pins.js'